I welcome contributions from the community and are pleased that you are interested in sharing your improvements or fixes to the HP48 GX utilities. This document outlines the contribution process to ensure a smooth collaboration.
Before you begin:
- Ensure you have a GitHub account.
- Submit an issue discussing your proposed change, unless there is an existing issue that matches your contribution.
- Fork the repository on GitHub.
- Clone your fork of the repository to your local machine.
- Create a new branch for your changes:
git checkout -b my-feature-branch
. - Make your changes in your branch, adhering to the coding conventions and documentation style of the project.
- Test your changes to ensure they are functioning as expected.
- Commit your changes, keeping your commit messages clear and relevant.
- Push your changes to your fork on GitHub:
git push origin my-feature-branch
. - Submit a pull request to the
hexo-toolkit
repository, linking to any relevant issues it addresses. - Await review from the project maintainers, who may suggest further refinements.
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository to your local repository.
Thank you for contributing to HP48 GX utilities!