From 8441b11a42c5e0ad69b8d170dae9bad2ee877c92 Mon Sep 17 00:00:00 2001 From: SAIKAT KARMAKAR Date: Sat, 22 Jun 2024 23:54:49 +0530 Subject: [PATCH] docs: readme updated. fix: fixed issues with documentations --- CONTRIBUTING.md | 12 ++++++------ README.md | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9dc744f..e1ee49e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ the development processes, but [other kinds of contributions] are also appreciat If you are new to using [git] or have never collaborated in a project previously, please have a look at [contribution-guide.org]. Other resources are also -listed in the excellent [guide created by FreeCodeCamp] [^contrib1]. +listed in the excellent [guide created by FreeCodeCamp]. Please notice, all users and contributors are expected to be **open, considerate, reasonable, and respectful**. When in doubt, @@ -150,10 +150,10 @@ This often provides additional considerations and avoids unnecessary work. the PR as a draft first and mark it as ready for review after the feedbacks from the continuous integration (CI) system or any required fixes. -[^contrib1]: Even though, these resources focus on open source projects and - communities, the general ideas behind collaborating with other developers - to collectively create software are general and can be applied to all sorts - of environments, including private companies and proprietary code bases. +Even though, these resources focus on open source projects and +communities, the general ideas behind collaborating with other developers +to collectively create software are general and can be applied to all sorts +of environments, including private companies and proprietary code bases. [black]: https://pypi.org/project/black/ [contribution-guide.org]: http://www.contribution-guide.org/ @@ -167,4 +167,4 @@ This often provides additional considerations and avoids unnecessary work. [pipx]: https://pypa.github.io/pipx/ [python software foundation's code of conduct]: https://www.python.org/psf/conduct/ [Google style]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings -[guide created by FreeCodeCamp]: https://github.com/FreeCodeCamp/how-to-contribute-to-open-source \ No newline at end of file +[guide created by FreeCodeCamp]: https://github.com/FreeCodeCamp/how-to-contribute-to-open-source diff --git a/README.md b/README.md index 4c8db98..07a5dac 100644 --- a/README.md +++ b/README.md @@ -92,4 +92,4 @@ It'll automatically watch for changes in your code. ## License -This project is licensed under the terms of the [BSD 3-Clause License](./LICENSE) license. +This project is licensed under the terms of the [BSD 3-Clause License](https://github.com/Ankvik-Tech-Labs/mantaray-py/blob/main/LICENSE) license.