diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 72494f8a..c5c40455 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -19,7 +19,7 @@ Please note that we have a [code of conduct](/CODE_OF_CONDUCT.md). Please follow From here, you might want to fix and issue or bug, or add a new feature. Jump to the relevant section to proceed. -### ...to fix an issue or bug +### Fixing an Issue or Bug - Create a GitHub issue with a [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example), @@ -33,7 +33,7 @@ relevant section to proceed. Once you've completed these steps, you are ready to submit your contribution. -### ...to contribute a new feature +### Contributing a New Feature - Create an issue and discuss the feature's scope and its fit for this package with the team - Create a branch for your new feature in your fork @@ -44,15 +44,15 @@ Once you've completed these steps, you are ready to submit your contribution. Once you've completed these steps, you are ready to submit your contribution. -### ...to contribute to docs +### Contributing to Documentation -#### Documentation Style +#### Documentation Style -To ensure that our code is well-documented and easy to understand, we use [Google-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) to document all functions, classes, and methods in this library +To ensure that our code is well-documented and easy to understand, we use [Google-style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) to document all functions, classes, and methods in this library. #### Getting Help with Setup and Configuration -To work on docs locally follow the steps below: +To work on documentation locally, follow these steps: - To setup the documentation, navigate to the scripts directory - Run the `scripts/build-docs.sh` script to build the documentation @@ -62,7 +62,7 @@ If you encounter any issues while setting up the documentation using the provide #### Caveats and Considerations -Our mkdocs setup has a known limitation: the hot reloader won't auto-reload when changing docstrings. To see updates, manually rebuild and re-serve docs. We're working to improve the dev experience and appreciate your patience. +Our mkdocs setup has a known limitation: the hot reloader won't auto-reload when changing docstrings. To see updates, manually rebuild and re-serve docs. We're working to improve the developer experience and appreciate your patience. ## Submitting your contribution @@ -78,9 +78,9 @@ Our mkdocs setup has a known limitation: the hot reloader won't auto-reload when #### Usage of Pre-Commit -To maintain code quality, we use pre-commit for automated checks before committing changes. Install and configure pre-commit to ensure high-quality contributions +To maintain code quality, we use pre-commit for automated checks before committing changes. Install and configure pre-commit to ensure high-quality contributions. -To set up pre-commit follow these steps: +To set up pre-commit, follow these steps: - `pip install pre-commit` for Windows and for Linux refer to your distribution's package index - `pre-commit install` to enable it to run automatically @@ -99,12 +99,11 @@ We have included type stubs for the untyped `python-cmr` library, which we inten ## Pull Request process 1. Ensure you include test coverage for all changes -2. Ensure your code is formatted properly following this document -3. Update the documentation and the `README.md` with details of changes to the - interface, this includes new environment variables, function names, - decorators, etc. -4. Update `CHANGELOG.md` with details about your change in a section titled +1. Ensure your code is formatted properly following this document +1. Update the documentation and the `README.md` with details of changes to the + interface, this includes new environment variables, function names,decorators, etc. +1. Update `CHANGELOG.md` with details about your change in a section titled `Unreleased`. If one does not exist, please create one. -5. You may merge the Pull Request once you have the sign-off of another +1. You may merge the Pull Request once you have the sign-off of another developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.