We welcome all contributions, typo corrections, and general feedback.
Pull requests should be made against the main branch.
While not mandatory, we encourage the use of prefixed branches. These are the currently used prefixes:
content: edits applying to site content.
feature: new features for the website.
fix: fixes an error in existing code.
- As mentioned above, your contribution will be a branch based off of
main - Once it's ready for review, please create a new Pull Request to be merged into (aka base branch)
main - Upon creation of a Pull Request, a preview build will be generated in the CI output in the comment thread. Click on the "Details" link to the right of the
fleek/buildrow to view. - PRs from Truffle team members require at least one review approval; PRs from external contributors are recommended (though not required) to have >1 review
- PRs that pass all automatic checks and meet the approval criteria above may be merged by anyone (though give the author time to merge it themselves, as they deserve the satisfaction of pushing the button)
- After a PR has been merged, please delete the original branch
We welcome translations as well. If you are interested in translating Truffle documentation to a different language:
- Copy the content you wish to translate (feel free to fork the repository).
- Host the translated documentation (you can use GitHub Pages or any hosting solution).
- Create an issue pointing to your hosted translations.
We will then review and link to your documentation. Thank you!