chore: update CONTRIBUTING.md (#31)

This commit is contained in:
Takeshi Kimata
2024-09-22 12:05:55 +09:00
committed by GitHub
parent 58cc5dbc36
commit cabce11143

View File

@@ -4,13 +4,22 @@ Thank you for your interest in contributing to this project! We're excited to ha
Here are a few simple guidelines to get started:
1. **Submitting Issues**
## Submitting Issues
- Feel free to open an issue if you find a bug, have a question, or want to suggest a feature. Please provide as much detail as possible.
Feel free to open an issue if you find a bug, have a question, or want to suggest a feature. Please provide as much detail as possible.
2. **Pull Requests**
## Pull Requests
- When submitting a pull request, please ensure that your changes are well-tested and documented where necessary.
- We recommend opening an issue first if you plan to work on a new feature or significant change, so we can discuss it.
The `main` branch is a snapshot of the latest production version. All development must be done in dedicated branches and will be merged to `development` branch.
### Steps
1. We recommend opening an issue first if you plan to work on a new feature or significant change, so we can discuss it.
1. Fork the unittcms repository
1. Create a new branch out of the `develop` branch.
1. When submitting a pull request, please ensure that your changes are well-tested and documented where necessary.
1. It is no problem to have multiple commits while working on the PR. We'll let GitHub squash it automatically before the merge.
## Thanks
Thank you for your contributions! Every issue reported and pull request submitted helps make this project better.