Review changes to CONTRIBUTING.md

This commit is contained in:
Maybe Waffle 2024-02-15 21:41:26 +01:00
parent c934e678f6
commit 4ab24a0a0c

View file

@ -1,7 +1,5 @@
# Contributing # Contributing
Before contributing, please read [the license](./LICENSE).
> [!NOTE] > [!NOTE]
> >
> These contributing instructions might not be fully up-to-date or complete. > These contributing instructions might not be fully up-to-date or complete.
@ -43,11 +41,10 @@ For example:
You can learn more about [Using keywords in issues and pull requests] in github documentation. You can learn more about [Using keywords in issues and pull requests] in github documentation.
If your pull request suggests new functionality or new changes, If your pull request suggests new functionality or new changes, please explain your point of view and all the necessary details.
please explain your point of view and all the necessary details.
(pros, cons, why you chose design you chose, your use cases, etc) (pros, cons, why you chose design you chose, your use cases, etc)
In general try to make PR title/description clear, as they are the primary ways of communicating your intent to the reviewer In general try to make PR title/description clear, as they are the primary ways of communicating your intent to the reviewer.
[github issue]: https://github.com/teloxide/teloxide/issues [github issue]: https://github.com/teloxide/teloxide/issues
[Using keywords in issues and pull requests]: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests [Using keywords in issues and pull requests]: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests