Skip to content

Commit

Permalink
docs: readme updated. fix: fixed issues with documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
Aviksaikat committed Jun 22, 2024
1 parent fb93ddc commit 8441b11
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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/
Expand All @@ -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
[guide created by FreeCodeCamp]: https://github.com/FreeCodeCamp/how-to-contribute-to-open-source
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 8441b11

Please sign in to comment.