This project uses semantic versioning and semantic-release to automate versioning and package publishing. The project follows the semantic-release npm package, which automatically determines the next version number based on your commit messages and updates the release accordingly.
Branches:
main: Production-ready codealpha: Alpha and pre-release code
While using semantic commit messages is not mandatory, it helps ensure that automated releases follow semantic versioning. You can learn more about the semantic commit guidelines here.
-
Fork our repo by clicking the fork button in the top-right corner.
-
Clone the forked repo to your local system:
git clone https://github.com/<your-github-username>/Notpad
-
Navigate to the cloned repo:
cd Notpad -
Checkout the
alphabranch (for new features and fixes) ormain(for hotfixes):git checkout alpha
-
Create a new branch for your changes:
git checkout -b <your-branch-name>
-
Make your changes, then stage and commit them. If possible, follow semantic commit guidelines:
git add <folder-or-file-paths> git commit -m "feat: add new feature to enhance performance"
-
Push your changes to the remote repo:
git push origin <your-branch-name>
Congratulations! 🎉 You've contributed to Notpad! 🎊
The maintainers will review your PR. If it moves the project forward, it will be merged. If not, you'll receive constructive feedback to improve your contribution.
Feel free to open an issue to discuss potential contributions or suggest enhancements.