Skip to content

Commit 5d55045

Browse files
Merge pull request #19 from opencloud-eu/renameBranchInDocs
chore: rename branch in documentations
2 parents 3a71c00 + 0fe71f7 commit 5d55045

File tree

3 files changed

+22
-22
lines changed

3 files changed

+22
-22
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,26 +28,26 @@ Before we're able to merge your code into the OpenCloud app for Android, please,
2828
- ```improvement/improvement_name``` → make even better an existing feature
2929
- ```technical/technical_description``` → code review, DB... technical stuff improved
3030

31-
Please, use the mentioned prefixes because CI system is ready to match with them. Be sure your feature, fix, improvement or technical branches are updated with latest changes in official `android/master`, it will give us a better chance to test your code before merging it with stable code.
32-
* Once you are done with your code, start a pull request to merge your contribution into official `android/master`.
31+
Please, use the mentioned prefixes because CI system is ready to match with them. Be sure your feature, fix, improvement or technical branches are updated with latest changes in official `android/main`, it will give us a better chance to test your code before merging it with stable code.
32+
* Once you are done with your code, start a pull request to merge your contribution into official `android/main`.
3333
* Keep on using pull requests for your next contributions although you own write permissions.
3434
* Important to mention that ÒpenCloud Android team uses OneFlow as branching model. It's something as useful as easy:
3535

36-
* `master` will stay as main branch. Everything will work around it.
37-
* Feature branch: new branch created from `master`. Once it is finished and DoD accomplished, rebased and merged into `master`.
38-
* Release branch: will work as any feature branch. Before rebasing and merging into `master`, release tag must be signed.
39-
* Hotfix branch: created from latest tag. Once it is finished, tag must be signed. Then, rebased and merged into `master`.
36+
* `main` will stay as main branch. Everything will work around it.
37+
* Feature branch: new branch created from `main`. Once it is finished and DoD accomplished, rebased and merged into `main`.
38+
* Release branch: will work as any feature branch. Before rebasing and merging into `main`, release tag must be signed.
39+
* Hotfix branch: created from latest tag. Once it is finished, tag must be signed. Then, rebased and merged into `main`.
4040
* The way to get an specific version is browsing through the tags.
4141

4242
Interesting [link](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow) about this.
4343

44-
### 1. Fork and download android/master repository:
44+
### 1. Fork and download android/main repository:
4545

46-
* Please follow [SETUP.md](https://github.com/opencloud-eu/android/blob/master/SETUP.md) to setup OpenCloud Android app work environment.
46+
* Please follow [SETUP.md](https://github.com/opencloud-eu/android/blob/main/SETUP.md) to setup OpenCloud Android app work environment.
4747

4848
### 2. Create pull request:
4949

50-
* Create new feature, fix, improvement or technical enhancement branch from your master branch: ```git checkout -b feature/feature_name```
50+
* Create new feature, fix, improvement or technical enhancement branch from your main branch: ```git checkout -b feature/feature_name```
5151
* Register your changes: `git add filename`
5252
* Commit your changes locally. Please, if posible use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to add descriptive messages to the commits. Take the simplest approach:
5353
- Feature commits: `feat: brief description of the changes performed`
@@ -60,17 +60,17 @@ Before we're able to merge your code into the OpenCloud app for Android, please,
6060
* Browse to https://github.com/YOURGITHUBNAME/android/pulls and issue pull request
6161
* Enter description and send pull request.
6262

63-
### 3. Update your contribution branch with master changes:
63+
### 3. Update your contribution branch with main changes:
6464

6565
It is possible you see the next message from time to time.
6666

6767
<img src="docs_resources/out_of_date_branch.png" />
6868

69-
To fix this and make sure your contribution branch is updated with official android/master, you need to perform the next steps:
70-
* Checkout your master branch: ```git checkout master```
71-
* Get and apply official android/master branch changes in your master branch: ```git fetch upstream``` + ```git rebase upstream/master```. Now you have your master branch updated with official master branch changes.
69+
To fix this and make sure your contribution branch is updated with official android/main, you need to perform the next steps:
70+
* Checkout your main branch: ```git checkout main```
71+
* Get and apply official android/main branch changes in your main branch: ```git fetch upstream``` + ```git rebase upstream/main```. Now you have your main branch updated with official main branch changes.
7272
* Checkout your contribution branch: ```git checkout feature/feature_name```
73-
* Rebase contribution branch with master to put your contribution commits after the last commit of master branch, ensuring a clean commits history: ```git rebase master```. If there's some conflicts, solve it by using rebase in different steps.
73+
* Rebase contribution branch with main to put your contribution commits after the last commit of main branch, ensuring a clean commits history: ```git rebase main```. If there's some conflicts, solve it by using rebase in different steps.
7474
* Push branch to server: ```git push -f origin feature/feature_name```. At this point, the message ```This branch is out-of-date with the base branch``` should disappear.
7575

7676
## Versioning

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88

99
**Build status:** <br>
1010

11-
|master (Unit tests and data instrumented tests)| ![](https://app.bitrise.io/app/FIXME/status.svg?token=FIXME&branch=master)|
12-
| :----- | :------ |
13-
|**master (UI tests)**| ![](https://app.bitrise.io/app/FIXME/status.svg?token=FIXME/&branch=master)|
11+
| main (Unit tests and data instrumented tests) | ![](https://app.bitrise.io/app/FIXME/status.svg?token=FIXME&branch=main)|
12+
|:----------------------------------------------| :------ |
13+
| **main (UI tests)** | ![](https://app.bitrise.io/app/FIXME/status.svg?token=FIXME/&branch=main)|
1414

1515

16-
**Start contributing:** Make sure you read [SETUP.md](https://github.com/opencloud-eu/android/blob/master/SETUP.md) when you start working on this project. Basically: Fork this repository and contribute back using pull requests to the master branch.
16+
**Start contributing:** Make sure you read [SETUP.md](https://github.com/opencloud-eu/android/blob/main/SETUP.md) when you start working on this project. Basically: Fork this repository and contribute back using pull requests to the main branch.
1717
Easy starting points are also reviewing [pull requests](https://github.com/opencloud-eu/android/pulls) and working on [contributions are welcome](https://github.com/opencloud-eu/android/issues?q=is%3Aopen+is%3Aissue+label%3A%22Contributions+are+welcome%22).
1818

19-
**License:** [LICENSE.txt](https://github.com/opencloud-eu/android/blob/master/LICENSE.txt)
19+
**License:** [LICENSE.txt](https://github.com/opencloud-eu/android/blob/main/LICENSE.txt)
2020

2121
## Join testing!
2222

SETUP.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ Next steps will assume you have a Github account and that you will get the code
3636
* Open a terminal and go on with the next steps in it.
3737
* Clone your forked repository: ```git clone https://github.com/YOURGITHUBNAME/android.git```.
3838
* Move to the project folder with ```cd android```.
39-
* Fetch and apply any changes from your remote branch 'master': ```git fetch``` + ```git rebase```
39+
* Fetch and apply any changes from your remote branch 'main': ```git fetch``` + ```git rebase```
4040
* Make official OpenCloud repo known as upstream: ```git remote add upstream https://github.com/opencloud-eu/android.git```
41-
* Make sure to get and apply the latest changes from official android/master branch: ```git fetch upstream``` + ```git rebase upstream/master```
41+
* Make sure to get and apply the latest changes from official android/main branch: ```git fetch upstream``` + ```git rebase upstream/main```
4242

4343
At this point you can continue using different tools to build the project. Section 2 and 3 describe the existing alternatives.
4444

@@ -69,7 +69,7 @@ The first time the Gradle wrapper is called, the correct Gradle version will be
6969
The generated APK file is saved in android/build/outputs/apk as android-debug.apk
7070

7171

72-
[0]: https://github.com/opencloud-eu/android/blob/master/CONTRIBUTING.md
72+
[0]: https://github.com/opencloud-eu/android/blob/main/CONTRIBUTING.md
7373
[1]: https://git-scm.com/
7474
[2]: https://git-scm.com/downloads
7575
[3]: https://developer.android.com/sdk/index.html

0 commit comments

Comments
 (0)