readme update contribute #85
29
README.md
29
README.md
@ -8,6 +8,9 @@
|
||||
- [Create a New mdBook](#create-a-new-mdbook)
|
||||
- [Use Hero with Docker](#use-hero-with-docker)
|
||||
- [Contribute](#contribute)
|
||||
- [Branches and Forks](#branches-and-forks)
|
||||
- [Overview](#overview-1)
|
||||
- [Content Update Procedure](#content-update-procedure)
|
||||
|
||||
## Overview
|
||||
|
||||
@ -57,7 +60,29 @@ You can use Hero with Docker. Read the docs [here](https://git.ourworld.tf/tfgri
|
||||
|
||||
## Contribute
|
||||
|
||||
To contribute to this repository, make a pull request of your changes.
|
||||
To optimize updates to this repository, we propose a uniform way to collaborate.
|
||||
|
||||
### Branches and Forks
|
||||
|
||||
To contribute to this repository, make a pull request of your changes. There are two main methods.
|
||||
|
||||
1. Fork the repository and make a pull requests with your changes
|
||||
2. If you have access, create a new branch in this repo and make a pull request with your changes
|
||||
2. If you have access, create a new branch in this repo and make a pull request with your changes
|
||||
|
||||
### Overview
|
||||
|
||||
- The production-ready content is published on the **main** branch
|
||||
- The staging content is published on the **development** branch
|
||||
- Any changes to development must go through a pull request (PR) and its associated review from a different branch with the prefix `development_`.
|
||||
- The name of the branch should indicate the work being done, e.g. working on the readme, `development_readme_work`
|
||||
- Once staging is done on development, the code owners will merge development branch to main branch.
|
||||
- The mdbooks will be updated online.
|
||||
|
||||
### Content Update Procedure
|
||||
|
||||
- Create new branch out of development (e.g. `development_work`)
|
||||
- Make changes to the files
|
||||
- Make a PR to merge to development
|
||||
- Get reviewed and adjust accordingly
|
||||
- PR is approved and the content is merged to development
|
||||
- Code owners will merge development to main to update the books online
|
Loading…
Reference in New Issue
Block a user