We love your input! We want to make contributing to the Movement Docs as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
-
Fork the repo and create your branch from
main. -
Clone your forked repository to your local machine.
-
Create a new branch for your changes:
git checkout -b feature/your-feature-name
-
Make your changes and test them thoroughly. Especially if you are adding a tutorial, make sure it is complete and works as expected.
-
Commit your changes using descriptive commit messages in the present tense:
- ✅ Good: "Add tutorial for pump fun contract"
- ✅ Good: "Fix navigation bug in sidebar"
- ❌ Bad: "Added new stuff"
- ❌ Bad: "Fixed bug"
-
Push to your fork:
git push origin feature/your-feature-name
-
Open a Pull Request against the
mainbranch of the original repository.
- Ensure your PR description clearly describes the problem and solution or additional information regarding the content you are adding.
- Include the relevant issue number if applicable.
- Update the README.md with details of changes if needed.
- Your PR will be reviewed by maintainers, who may request changes.
- Once approved, your PR will be merged.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- 📚
:books:when writing docs - 🐛
:bug:when fixing a bug - ✨
:sparkles:when adding a new feature - 🔨
:hammer:when fixing or improving existing features - 🎨
:art:when improving the format/structure of the code
- 📚
- Feel free to open an issue for discussion
- Or reach out to the maintainers directly
By contributing, you agree that your contributions will be licensed under the project's Apache 2.0 and CC BY 4.0 licenses.