accounting/frappe_docker
2
0
Fork 0
mirror of https://github.com/frappe/frappe_docker.git synced 2024-11-08 06:15:26 +00:00
Code Issues Releases Activity

Add contributing.md by github standards

Browse Source
This commit is contained in:
Davide Bortolami 2020-03-24 15:00:46 +00:00
parent c59d7aef65
commit 55641c07de
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,25 @@
# Contribution Guidelines
## Branches
* *master*: images on the master branch are built monthly.
* *develop*: images on this branch are when commits are pushed.
# Pull Requests
Please send all pull request exclusively to the *develop* branch.
When the PR are merged, the merge will trigger the image build automatically.
Please test all PR as extensively as you can, considering that the software can be run in different modes:
* with docker-compose for production
* with or without Nginx proxy
* with VScode for testing environments
Every once in a while (or before monthly release) develop will be merged into master.
## Reducing the number of branching and builds :evergreen_tree: :evergreen_tree: :evergreen_tree:
Please be considerate when pushing commits and opening PR for multiple branches, as the process of building images (triggered on push and PR branch push) uses energy and contributes to global warming.
# Documentation
You should place README.md(s) in the relevant directories, explaining what the software in that particular directory does.