Skip to content

Commit 09554cf

Browse files
authored
Update CONTRIBUTING.md
1 parent 92a71e1 commit 09554cf

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,29 @@ email, or any other method with the owners of this repository before making a ch
88
Please note we have a code of conduct, please follow it in all your interactions with the project.
99

1010
### Pull Request Process
11-
12-
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
13-
build.
14-
2. If needed, update the README.md with details of changes to the interface, this includes new environment
15-
variables, exposed ports or useful file locations.
16-
3. There is no need to increase the projects version numbers in any of the files. We will increase the version numbers
17-
when your pull request gets merged into the master branch.
18-
4. Pull Requests are always reviewed by Crownpeak Technology developers and will also be merged by them. We may contact you during
19-
the process to make some changes to your pull request before we merge it into the master branch of the project.
11+
To help us review and integrate changes efficiently, please ensure your pull request (PR) meets the following criteria:
12+
13+
✅ Technical Requirements
14+
* The changes are concise and limited in scope (eg affecting the least amount of files necessary)
15+
* Backward compatibility is maintained
16+
* New functionality is thoroughly tested
17+
* Existing tests continue to pass without issues
18+
* The PR can be merged cleanly without conflicts
19+
* There is no need to increase the projects version numbers in any of the files. We will increase the version numbers when your pull request gets merged into the master branch.
20+
21+
📚 Code Quality & Documentation
22+
* Code follows the project's existing style and conventions (e.g., formatting, naming, structure)
23+
* Commit messages are clear, descriptive, and follow a consistent format (e.g., Conventional Commits)
24+
* Any new or modified functionality is accompanied by updated documentation (e.g., README, usage examples)
25+
* The PR includes a clear description of the problem being solved and how the solution addresses it
26+
* The PR does not include unrelated changes (e.g., refactoring, formatting, or general cleanup)
27+
28+
🛠 Additional Considerations
29+
* Any new dependencies are well-justified and as lightweight as possible
30+
* Performance implications have been considered and tested, if relevant
31+
32+
🔁 Review & Merge
33+
* Pull Requests are always reviewed by Crownpeak Technology developers and will also be merged by them. We may contact you during the process to make some changes to your pull request before we merge it into the master branch of the project.
2034

2135
### Code of Conduct
2236

0 commit comments

Comments
 (0)