From f1ce7c0f7b06d5245d5d3daa0450f35a797f5716 Mon Sep 17 00:00:00 2001 From: "Felipe S. S. Schneider" Date: Tue, 25 Oct 2022 14:35:52 -0300 Subject: [PATCH] Update contribution guidelines --- CONTRIBUTING.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9b2ad3c..e82e7f3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ forked repository. > **💡** If you're interested in contributing to open-source projects, make sure > to read -> ["How to Contribute to Open Source"](https://opensource.guide/how-to-contribute/) +> [“How to Contribute to Open Source”](https://opensource.guide/how-to-contribute/) > from [Open Source Guides](https://opensource.guide/) They may even have a > translation for your native language! @@ -17,10 +17,10 @@ for managing your contributions: ```console $ git clone git@github.com:your-username/overreact.git # your-username is your GitHub username $ cd overreact -$ poetry install +$ poetry install -E cli -E fast -E solvents # all optional features ``` -## Reccomended practices +## Recommended practices ### Reporting issues @@ -28,11 +28,12 @@ The easiest way to report a bug or request a feature is to [create an issue on GitHub](http://github.com/geem-lab/overreact/issues). The following greatly enhances our ability to solve the issue you are experiencing: -- Before anything, check if your issue is not already fixed in the repository +- Before anything, check if we haven't fixed your issue already in the repository by searching for similar issues in the [issue tracker](http://github.com/geem-lab/overreact/issues). -- Describe what you were doing when the error occurred, what actually - happened, and what you expected to see. Also, include the full traceback if +- Describe what you were doing when the error occurred, what + happened, and what you expected to see. + Also, include the full [traceback](https://realpython.com/python-traceback/) if there was an exception. - Tell us the Python version you're using, as well as the versions of overreact (and other packages you might be using with it). @@ -41,7 +42,7 @@ following greatly enhances our ability to solve the issue you are experiencing: to help us identify the issue.** This also helps check that the issue is not with your own code. -### Support questions +### Asking questions Use the [discussions](https://github.com/geem-lab/overreact/discussions) for questions about your own code or on the use of overreact. (Please don't use the @@ -50,14 +51,14 @@ questions, the discussions are a better place to ask questions 😄.) ### Submitting patches -- Include tests if your patch is supposed to solve a bug, and explain clearly +- Include tests if your patch solves a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch. - Use [Black](https://black.readthedocs.io/) to auto-format your code. - Use - [Numpydoc docstrings](https://numpydoc.readthedocs.io/en/latest/format.html) + [Numpydoc documentation strings](https://numpydoc.readthedocs.io/en/latest/format.html) to document your code. -- Include a string like "fixes #123" in your commit message (where 123 is the +- Include a string like “fixes #123” in your commit message (where 123 is the issue you fixed). See [Closing issues using keywords](https://help.github.com/articles/creating-a-pull-request/). - Bump version according to [semantic versioning](https://semver.org/).