Merge pull request #368 from yozachar/workshop

chore: documentation maintenance

CONTRIBUTING.md

@@ -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.

README.md

@@ -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/)

docs/index.md

@@ -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/)

docs/index.rst

@@ -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/>`__

mkdocs.yaml

@@ -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"