From 90674fb80ea5353d6d0442560f5680969047a62f Mon Sep 17 00:00:00 2001 From: David Mehren Date: Sat, 30 Jan 2021 18:37:45 +0100 Subject: [PATCH] Docs: Emphasize the difference between branches 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 --- CONTRIBUTING.md | 6 +++++- README.md | 6 +++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 996c0ba94..ac8e9a3c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 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? * 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. 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). -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. ### Commit guidelines diff --git a/README.md b/README.md index 87edc39ec..b209f428d 100644 --- a/README.md +++ b/README.md @@ -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 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 - 1.x source code, have a look at the `master` branch. +- 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.** - 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 1.x release is maintenance-only. We do not accept feature requests or PRs for this release anymore and may choose