Thank you for considering contributing to this project! 🚀
Before submitting a new issue or pull request, please:
- Check if an open issue already exists for the problem or feature you intend to address.
- If a related issue already exists, consider contributing to the discussion there instead of opening a duplicate.
Follow these steps to contribute effectively:
-
Clone the repository
git clone git@github.com:TenorioStephano/backstack-example.git cd https://github.com/TenorioStephano/backstack-example -
Create a new branch using the following naming convention:
git checkout -b feature-<your-feature-name>
-
Follow the Conventional Commits specification when writing commit messages.
A Conventional Commit is a lightweight convention for commit messages that provides a consistent way to structure the history of changes. The general format is:
<type>(optional-scope): <description>Examples:
feat: add new authentication flowfix(login): correct password validation errordocs: update README with setup instructions
Common types include:
feat: a new featurefix: a bug fixdocs: documentation only changeschore: maintenance tasks (e.g., build system, CI)
-
Push your branch and open a Pull Request (PR) targeting the
mainbranch. -
In your PR description, link to any relevant issues and provide a clear summary of the changes you are proposing.
Thanks for helping us make this project better! 🙌