Skip to content

Commit aeb52b2

Browse files
committed
Add CONTRIBUTING.md
1 parent a4ef1d3 commit aeb52b2

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing to mod\_proxy\_cluster
2+
3+
Before contributing please read our [Code of Conduct](https://github.com/modcluster/mod_proxy_cluster/blob/main/CODE_OF_CONDUCT.md)
4+
and [README](https://github.com/modcluster/mod_proxy_cluster/blob/main/README.md).
5+
6+
## How to contribute
7+
8+
### Reporting bugs
9+
10+
Please create an issue here in the repository with a clear description and steps to reproduce (if any).
11+
12+
### Providing patches
13+
14+
By contributing a code to the repository, you agree with the
15+
[Code of Conduct](https://github.com/modcluster/mod_proxy_cluster/blob/main/CODE_OF_CONDUCT.md) and
16+
the [license](https://github.com/modcluster/mod_proxy_cluster/blob/main/LICENSE).
17+
18+
To contribute, fork this repository and prepare your contribution. Make sure the code adheres to our code style,
19+
commit messages are clear, and that the workflow pipelines are not failing. Also, make sure that your fork is up to date
20+
and is not missing any upstream commits. Once you checked all of these, open a pull request against the right branch (see
21+
the section below) and wait for a review.
22+
23+
#### Branches
24+
25+
* `main` – the default branch for the development, the default target for pull requests
26+
27+
* `1.3.x` – the source for 1.3.x releases, changes from `main` are backported here – open pull requests against this branch
28+
**only** in cases the changes are applicable to 1.3.x releases only
29+

0 commit comments

Comments
 (0)