First, create your branch following Hydrogen's Branch Naming Convention and commits using Hydrogen's Commit Standard, remember that your branch needs to have only one change, this doesn't mean how many commits or how many files were affected but what has been changed (if you are changing how commands are handled, you will not fix a bug in the music player for example).
After finishing your changes on your branch, create a Pull Request to the main branch, write a concise title in imperative, present tense (like Change how commands are handled) and describing what you have changed and why (if applicable), and a reviewer will approve, close, or comment, and depending on the decision of the reviewer, your branch will be merged. Consider that if your Pull Request is approved this doesn't mean it will be merged, because this depends on what type (major, minor or patch) the next version will be, in this case, you will need to wait before seeing your changes on the upstream.
Please, don't forget to log your changes in the CHANGELOG.md file following the Keep a changelog v1.1.0 before making the Pull Request.
Hydrogen I18n uses Rust v1.80, make sure you are using this version before making any changes.
The Hydrogen's Commit Standard is based on Angular's Commit Message Guidelines with a simpler format that only the header (<type>(<scope>): <subject>) is present.
This project uses a modified version of it that considers the differences between the projects.
- build: Changes on the build system-related files. (like
DockerfileorCargo.toml) - chore: Other types of changes like changes on the VSCode's
launch.jsonor.gitignore. - ci: Changes to our CI configuration files and scripts.
- docs: Changes to the documentation files.
- feat: A new feature.
- fix: A bug fix.
- refactor: A code rewrite that doesn't affect the API.
- refactor!: A code rewrite that affects the API.
Commit scopes describe what has been affected by the commit, below is a list of scopes used in this repository:
This project does not have scopes.
You can omit the scope (example feat: create new module for ...) if your commit there's no scope documented or is from other types that don't feat, fix, and refactor.
A short description containing what happened on this commit using the imperative, present tense ("change" not "changed" nor "changes") with the first letter lowercase, not ending with a dot (.).
Hydrogen's Branch Naming Conventions are based on the Simplified Convention for Naming Branches and are similar to Hydrogen's Commit Standard and have the format <type>/<description>.
- docs: Changes to the documentation files.
- feat: A new feature or refactor on some existing feature.
- fix: A bug fix.
- chore: Changes to non-documented things, like CI or build system files.
A short description containing what will be changed on that branch using the imperative, present tense ("change" not "changed" nor "changes").
The Hydrogen's Changelog file and GitHub Releases are based on Keep a changelog v1.1.0 without any change.
Hydrogen Framework is composed of all the projects related to Hydrogen like hydrogen-i18n and hydrolink, and there's a GitHub Project to track the proposed ideas and development progress of Hydrogen, if you want to implement something please check if it is already tracked on the project (anything not tracked will be rejected) and if not, consider suggesting thought GitHub Issues.