Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

chore: documentation maintenance #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 19, 2024
Merged

chore: documentation maintenance #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aaccf08
chore: adds contribution guidelines
yozachar Apr 19, 2024
54917a0
fix: use backup url from documentation
yozachar Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions 35 CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# How to contribute to `validators`

Hi, to start, you need the following installed on your system.

1. [Git](https://git-scm.com/)
2. [Python](https://www.python.org/) v3.8 or later and
3. [PDM](https://pdm-project.org/en/stable/) for easy dependency management.
4. (Optional/Recommended) NodeJS for type checking.
5. (Optional/Recommended) [mise](https://github.com/jdx/mise) to manage multiple versions of Python, NodeJS etc.


First [fork](https://github.com/python-validators/validators/fork) this repository. Then clone it to your system. Then install development dependencies.


```sh
# cloning repository
$ git clone "https://github.com/YOUR_USERNAME/validators.git"
# changing directory
$ cd validators
# installing development dependencies
$ pdm install
```

Activate the virtual environment and run `tox` to verify test cases.

```sh
# activate virtual environment
$ . ./.venv/bin/activate # replace `/bin/` with `/Scripts/` if you're on Windows.
# run tox for linting, type checking, formatting etc.
$ tox
```

Create a git branch. You can now make changes to the source code. If needed, test your change by running `pytest`. Commit, push and create a pull request.

If you're in doubt feel free to start a discussion [here](https://github.com/python-validators/validators/discussions). Thanks for taking interest in this library.
4 changes: 2 additions & 2 deletions 4 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ True

## Resources

<!-- Temporary documentation URL : https://yozachar.github.io/pyvalidators/ -->
<!-- Backup documentation URL : https://yozachar.github.io/pyvalidators/ -->
<!-- Original documentation URL : https://python-validators.github.io/validators/ -->

- [Documentation](https://python-validators.github.io/validators/)
- [Documentation](https://yozachar.github.io/pyvalidators)
- [Bugtracker](https://github.com/python-validators/validators/issues)
- [Security](https://github.com/python-validators/validators/blob/master/SECURITY.md)
- [Code](https://github.com/python-validators/validators/)
Expand Down
4 changes: 2 additions & 2 deletions 4 docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ True

## Resources

<!-- Temporary documentation URL : https://yozachar.github.io/pyvalidators/ -->
<!-- Backup documentation URL : https://yozachar.github.io/pyvalidators/ -->
<!-- Original documentation URL : https://python-validators.github.io/validators/ -->

- [Documentation](https://python-validators.github.io/validators/)
- [Documentation](https://yozachar.github.io/pyvalidators)
- [Bugtracker](https://github.com/python-validators/validators/issues)
- [Security](https://github.com/python-validators/validators/blob/master/SECURITY.md)
- [Code](https://github.com/python-validators/validators/)
Expand Down
4 changes: 2 additions & 2 deletions 4 docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ Resources

.. raw:: html

<!-- Temporary documentation URL : https://yozachar.github.io/pyvalidators/ -->
<!-- Backup documentation URL : https://yozachar.github.io/pyvalidators/ -->

.. raw:: html

<!-- Original documentation URL : https://python-validators.github.io/validators/ -->

- `Documentation <https://python-validators.github.io/validators/>`__
- `Documentation <https://yozachar.github.io/pyvalidators>`__
- `Bugtracker <https://github.com/python-validators/validators/issues>`__
- `Security <https://github.com/python-validators/validators/blob/master/SECURITY.md>`__
- `Code <https://github.com/python-validators/validators/>`__
Expand Down
4 changes: 2 additions & 2 deletions 4 mkdocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
site_name: "validators"
site_description: "Automatic documentation from sources, for MkDocs."
site_url: "https://python-validators.github.io/validators/"
repo_url: "https://github.com/python-validators/validators"
site_url: "https://yozachar.github.io/pyvalidators/"
repo_url: "https://github.com/python-validators/validators/"
edit_uri: "edit/master/docs/"
repo_name: "validators/validators"
site_dir: "site"
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.