Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on the Chunky Manual.
Read our Code of Conduct to keep our community approachable and respectable.
In this guide, you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
When contributing to this repository, please consider discussing significant changes you wish to make via an issue or the #docs channel on our Discord server prior to making a change. Correcting spelling or grammar mistakes, or refining existing docs are not considered significant. A full rewrite of larger articles, adding new articles, new mkdocs plugins, etc. can be considered more significant changes.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
Be sure to read and understand the style guide and the versioning guide before making any changes.
Click on the pencil icon at the top right of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .md file where you can make your changes and create a pull request for a review.
- Fork the repository.
-
Using GitHub Desktop:
-
Getting started with GitHub Desktop will guide you through setting up Desktop.
-
Once Desktop is set up, you can use it to fork the repo.
-
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
-
GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
-
Install or update to Python 3.5 or newer.
-
Install the required packages with pip by using the command,
pip3 install -r requirements.txt. -
Create a working branch and start with your changes!
-
Change the working directory to
./ChunkyDocs. -
Serve the site for development by using either the command,
CHUNKY_VERSION=20406 python -m mkdocs serve, or the command,CHUNKY_VERSION=20500 python -m mkdocs serve, depending on the version of Chunky for which you want to serve documentation.
Alternatively, on Windows, you can run either "serve_stable.bat" or "serve_snapshot.bat", depending on the version of Chunky for which you want to build documentation.
Commit the changes once you are happy with them.
When you're finished with the changes, create a pull request, also known as a PR.
-
Provide a short but descriptive name and for more complex changes an extended description.
-
Don't forget to link PR to issue if you are solving one.
-
Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
-
We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
-
As you update your PR and apply changes, mark each conversation as resolved.
-
If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations 🎉🎉 The Chunky team thanks you ✨.
Once your PR is merged, your contributions will be publicly visible on the Chunky Manual.
This Contributing guide is adapted from the contributing guide for the GitHub docs.