- Create a new branch for your fix using
git checkout -b branch-name-here. - Make the appropriate changes for the issue you are trying to address or the feature that you want to add. If you are adding a feature or changing functionality, please write tests! 👍 Tests will help your PR get merged faster.
- Add and commit the changed files using
git addandgit commit. We use Conventional Changelog Standard for our commit messages. More info on that below. - Push the changes to the remote repository using git push origin branch-name-here.
- Submit a PR to the upstream repository.
- Please title your PR using Conventional Changelog Standard. Set the description of the PR with a brief description of what you did and any questions you might have about what you did..
- Wait for the PR to be reviewed by a maintainer.
- Once your PR is merged, celebrate! 🎉 You did it!
If any of the instructions above are unclear, please file an issue so we can improve them!
We use Conventional Changelog Standard for all commit messages and PR titles. Please adhere to these guidelines so your PR can be merged faster.
Example:
refactor(templates): revised imports in obj-c header files
The prefix (fix in the example) should be one of the following:
- fix: You fixed a bug
- feat: You added a new feature
- chore: You completed a chore on the repository, such as upgrading a dependency
- docs: You added or revised documentation
- refactor: You refactored a method or file
The affected part of the application (templates in the example) should describe the part of the application you're changing.