Skip to content

Commit 315835d

Browse files
committed
Add CONTRIBUTING.md
1 parent 06c3714 commit 315835d

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to byjg/php-swagger-test
2+
3+
First of all, thank you for taking the time to contribute!
4+
5+
## How to Contribute
6+
7+
### Issues
8+
9+
If you encounter any issues, have questions, or need clarification, please open an issue on our [Issues page](https://github.com/your-repo/issues). This helps us track and prioritize bug fixes and enhancements.
10+
11+
### Branches
12+
13+
We have three main branches in this project:
14+
15+
- **master**: Contains the latest code. It is generally stable, but we recommend using it with caution.
16+
- **a.b**: Use this branch for creating PRs. The naming convention follows `a.b`, where `a` is the major release and `b` is the minor release of the current version. For example, if the current release is 4.9.2, use the branch `4.9` for your PR. You can also use `4.9.x-dev` in your composer for development purposes.
17+
- **future release**: This branch is typically `(a+1).0`. For instance, if the current release is 4.9.2, the future release branch will be `5.0`.
18+
19+
20+
### Code Style and Guidelines
21+
22+
- **Follow PSR Standards**: We follow [PSR-1](https://www.php-fig.org/psr/psr-1/), [PSR-2](https://www.php-fig.org/psr/psr-2/), and [PSR-12](https://www.php-fig.org/psr/psr-12/).
23+
- **Write Clear Commit Messages**: Use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
24+
- **Documentation**: Update the documentation for any new features or changes.
25+
26+
### Common Practices
27+
28+
- **Keep Pull Requests Small**: Smaller PRs are easier to review and merge. Focus on one feature or fix per PR.
29+
- **Write Tests**: Ensure your changes are covered by tests. We aim for a high level of test coverage.
30+
- **Respect Reviewers' Time**: Be responsive to feedback and willing to make necessary changes.
31+
32+
### Community
33+
34+
- **Be Respectful**.
35+
- **Collaborate**: We encourage collaboration and open discussion. Don’t hesitate to ask for help or provide feedback.
36+
37+
Thank you for contributing to byjg/php-swagger-test! Your help is appreciated and makes a big difference.

0 commit comments

Comments
 (0)