Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
There are many ways you can send your contributions to the Yarn Spinner documentation. You can either report a bug, or you can make the changes yourself and submit a pull request!
Please report errors in the documetation and open issues generously. Don't be afraid that your idea is silly, or you're reporting a duplicate. We're happy to hear from you. Seriously.
The easiest way to contribute to Yarn Spinner's documentation is via a pull request.
- Fork and clone the repository
- Create a new branch: git checkout -b my-branch-name
- Make your changes
- Push to your fork and submit a pull request
- Pat your self on the back and wait for your pull request to be reviewed.
If you're unfamiliar with how pull requests work, GitHub's documentation on them is very good.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Update the documentation as necessary, as well as making code changes.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
The documentation used on yarnspinner.dev is driven by the contents of the master branch. When this branch is updated, the site is updated shortly afterwards.
Contributions to the Yarn Spinner documentation (via pull request or otherwzise) must be licensed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International license.