github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-24 18:56:32 -05:00
Code Issues Projects Releases Packages Wiki Activity

Docs: Emphasize the difference between branches

Browse source 
To further reduce confusion between the `develop` and `master` branches,
this commit adds more information about them in the README
and the contribution docs.

Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-01-30 18:37:45 +01:00
parent c42871be66
commit 90674fb80e
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -35,6 +35,10 @@ Please note we have a [code of conduct][code-of-conduct], please follow it in al
* Please note that we only accept PRs for the 1.x releases if they fix critical issues. If you are unsure if your fix is * Please note that we only accept PRs for the 1.x releases if they fix critical issues. If you are unsure if your fix is
critical, it's best to ask us before you start coding. critical, it's best to ask us before you start coding.
* **Choose the correct base branch:**
The code for 1.x lives in the `master` branch. docs.hedgedoc.org is also deployed from there until 2.0 is released.
HedgeDoc 2.x is developed in the `develop` branch.
### Do you intend to add a new feature or change an existing one? ### Do you intend to add a new feature or change an existing one?
* Suggest your idea via a new GitHub issue. After a confirmation about your idea, you can start writing code. Our * Suggest your idea via a new GitHub issue. After a confirmation about your idea, you can start writing code. Our
@ -72,7 +76,7 @@ like `git config --global alias.ci 'commit -s'`. Now you can commit with `git ci
1. Submit an issue describing your proposed change. We will try to respond to your issue promptly. 1. Submit an issue describing your proposed change. We will try to respond to your issue promptly.
2. Fork this repo, develop and test your code changes. Ensure you follow the commit guidelines (see below) 2. Fork this repo, develop and test your code changes. Ensure you follow the commit guidelines (see below)
and signed all your commits (see above for details). and signed all your commits (see above for details).
3. Submit a pull request against this repo's `develop` branch. 3. Submit a pull request against this repo's `develop` branch for 2.x or the `master` branch for 1.x.
4. Your branch may be merged once all configured checks pass. 4. Your branch may be merged once all configured checks pass.
### Commit guidelines ### Commit guidelines

6
README.md
View file

@ -18,10 +18,10 @@ HedgeDoc 2
HedgeDoc lets you create real-time collaborative markdown notes. Have a look at [our website](https://hedgedoc.org) for HedgeDoc lets you create real-time collaborative markdown notes. Have a look at [our website](https://hedgedoc.org) for
more details. more details.
**Important:** We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please note the following: ⚠️⚠️⚠️ **Important:** We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please note the following:
- This branch contains the latest development code and does not implement all features yet. If you are looking for the - This branch contains the latest development code and does not implement all features yet. **If you are looking for the
1.x source code, have a look at the `master` branch. 1.x source code, have a look at the `master` branch.**
- HedgeDoc 2 will be split in two components: the backend (this repo) and the frontend in - HedgeDoc 2 will be split in two components: the backend (this repo) and the frontend in
the [react-client repo](https://github.com/hedgedoc/react-client). the [react-client repo](https://github.com/hedgedoc/react-client).
- The 1.x release is maintenance-only. We do not accept feature requests or PRs for this release anymore and may choose - The 1.x release is maintenance-only. We do not accept feature requests or PRs for this release anymore and may choose