Skip to content

Commit

Permalink
docs(README.md): add guidelines for commits and branch usage
Browse files Browse the repository at this point in the history
  • Loading branch information
@Codycody31
Codycody31 committed Dec 13, 2023
1 parent 3171f5b commit 854138c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,8 @@ We welcome contributions to this library. Feel free to submit issues and pull re

For those writing commits, please follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. This helps us maintain a consistent commit history and generate changelogs automatically.

Also, when making changes, only push to the `develop` branch. The `main` branch is reserved for stable releases as semantic-release will automatically publish to npm from there. The `develop` branch is used for development and testing, PR's will be squashed and merged into `develop` and then when ready, `develop` will be merged into `main`.

## License

This library is open-sourced under the MIT License, allowing for wide usage and modification. See the [LICENSE](LICENSE) file for details. Feel free to submit issues and pull requests to help improve the library.
Expand Down

0 comments on commit 854138c

Please sign in to comment.