Improved the documentation for contributing #30
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added some steps on how to create a virtual environment and install `pre-commit` to make it easier for new contributors to develop the library.
EGJ-Moorington
added
the
documentation
|
👋 Thanks for this pull request! Unfortunately, it looks like the automated continuous integration (CI) test(s) failed. These can be tricky to fix so we've written a guide on how to fix them locally. It has pages about running pre-commit locally and another about building the docs locally with sphinx. Thanks for contributing to CircuitPython! If you have more questions, feel free to join the Adafruit Discord and post in #circuitpython-dev. |
Added a small guide on how to fork the repository and open issues and pull requests for it.
EGJ-Moorington
force-pushed
the
29-improve-documentation-for-contributing
branch
from
4a266a1 to
ec366e0
Compare
EGJ-Moorington
added a commit
that referenced
this pull request
Jun 19, 2025
…or-contributing Improved the documentation for contributing by adding a small guide on opening issues and pull requests, forking the repository and working on a fork in `README.rst`. Closes #29
EGJ-Moorington
added a commit
that referenced
this pull request
Jun 19, 2025
…or-contributing Improved the documentation for contributing by adding a small guide on opening issues and pull requests, forking the repository and working on a fork in `README.rst`. Closes #29
Merged
EGJ-Moorington
added a commit
that referenced
this pull request
Jun 19, 2025
Release version 3.0.1 * Fixed Build CI workflow (#22) Fixes #17 * Fixed some typos in docstrings (#24) Resolves #23 * Fixed `__version__` constant (#27) Resolves #25 * Updated `.readthedocs.yaml` with Sphinx configuration key (#28) Resolves #26 * Improved the documentation for contributing (#30) Closes #29 * Updated SPDX licencing tags for release 3.0.1 (#34) Closes #33
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a small guide on opening issues and pull requests, forking the repository and working on a fork in
README.rst.Closes #29