Skip to content

Commit 6057b64

Browse files
docs: add instructions for pr target branches
1 parent 403e077 commit 6057b64

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,30 @@ To make a code contribution, please follow these steps:
2727
If your contribution involves a security vulnerability, please do not open a public issue or pull request. Instead,
2828
please report the vulnerability to a [project maintainer](index.md#maintainers) directly.
2929

30+
## Pull Requests
31+
32+
When submitting a pull request, please be aware of the various development branches used by the project and base your branch accordingly. Ensure your pull request's target branch is set to merge into the appropriate branch.
33+
34+
### next_patch
35+
36+
The `next_patch` branch is used for small bug fixes, minor documentation corrections, and other small changes that do not introduce new features or break existing functionality. Changes implemented in this branch will be included in the next patch release.
37+
38+
### next_minor
39+
40+
The `next_minor` branch is used for new features, enhancements, fixes, and other changes that do not introduce major breaking changes. Breaking changes _are_ allowed in minor release as long as the impact is minimal and justified. Changes implemented in this branch will be included in the next minor release.
41+
42+
### next_major
43+
44+
The `next_major` branch is dedicated to major changes to the projects structure, schemas, and overall functionality. Pull requests to this branch are allowed, but are rarely accepted as the branch is intended for fundamental changes to the project. Changes implemented in this branch will be included in the next major release.
45+
46+
### master
47+
48+
The `master` branch reflects the latest stable release of the project. Pull requests should _not_ be made to this branch directly. Instead, pull requests should be made to one of the other branches and merged into `master` when a new release is ready. Notable exceptions to this rule are:
49+
50+
- Emergency security fixes that need to be applied to the latest stable release.
51+
- Dependency updates that do not break existing functionality.
52+
- Documentation updates that are not tied to a specific release.
53+
3054
## Project Structure
3155

3256
The majority of the pfSense REST API package code can be found at `pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI`.

0 commit comments

Comments
 (0)