admin/frappe_docker
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

docs: organize docs

Browse Source 
break down readme into multiple files
organize in docs directory
[skip travis]
This commit is contained in:
Revant Nandgaonkar
2020-06-13 15:33:06 +05:30
parent 00541810d9
commit 38be99fc5e
8 changed files with 920 additions and 544 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@@ -1,25 +1,34 @@
# Contribution Guidelines
## Branches
* *master*: images on the master branch are built monthly.
* *develop*: images on this branch are built daily.
* *master*: images on the master branch are built monthly and with github action triggered by ERPNext release.
* *develop*: images on this branch are built daily and when PR is merged into develop.
# Pull Requests
Please **send all pull request exclusively to the *develop*** branch.
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.
Every once in a while (or with monthly release) develop will be merged into master.
There is Github Action is configured on ERPNext repository. Whenever there is a ERPNext release it will trigger a build on master branch of frappe_docker repo to generate images for released version.
When a PR is sent, the images are built and all commands are tested.
If update or fixes to documentation are pushed use `[skip travis]` anywhere in commit message to skip travis.
## Reducing the number of branching and builds :evergreen_tree: :evergreen_tree: :evergreen_tree:
## 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.
Place relevant markdown file(s) in the `docs` directory and index them in README.md located at the root of repo.