From 4e269371aab49f473b02b7b2cc4df0ec82d39a3e Mon Sep 17 00:00:00 2001 From: Rohit Singh Date: Wed, 3 Mar 2021 16:52:57 +0530 Subject: [PATCH] fix: branch name and contribution steps --- CONTRIBUTING.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d9a259eb7..524099a0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,10 +21,10 @@ To keep project away from disputes we make use of **ESLint**, which is really a In order to lint your code run following command. -``` +```bash cd AwesomeNativeBase -npm install eslint +yarn add eslint ``` ### 2. Git Flow @@ -33,7 +33,7 @@ NativeBase is an infant and growing rapidly, so we planned to stick to Git Flow. #### a. Reporting Bugs -- Always update to the most recent `master` release, the bug may already be resolved. +- Always update to the most recent `v3-dev` release, the bug may already be resolved. - Search for similar issues in the issues list for this repo. It may already be an identified problem. - If you want to contribute to an issue that is not part of this list, you are welcome to submit [new issue](https://github.com/GeekyAnts/NativeBase/issues/new) to our GitHub Repository. - In that case, provide a short description of the visible symptoms. Include error messages, screenshots, and stack traces. @@ -50,20 +50,20 @@ NativeBase is an infant and growing rapidly, so we planned to stick to Git Flow. - Before submitting a pull request, we appreciate if you create an issue first to discuss the change. - Fork the repo you are planning to work on. -- Create a new branch from branch `master`. +- Create a new branch from branch `v3-dev`. - Example: `my-new-feature` - - Note: Please have your branch named apart from `master` and `development`. + - Note: Please have your branch named apart from `master`, `development` and `v3-dev`. - Work on your branch until you are confident enough to create a pull request. - Conclude working on your branch and push to your forked repo. -- Create a pull request of your branch to NativeBase repo `master` branch. -- Provide a short description of the necessity and functionality of your PR. Include a step-by-step walkthrough of it with an use case example. +- Create a pull request of your branch to NativeBase repo `v3-dev` branch. +- Provide a short description of the necessity and functionality of your PR. Include a step-by-step walkthrough of it with an use case example. And add `v3` label to your pull request. - Link the issues that are related to your PR in the body. - If you have perfectly accompanied our contribution guide and that if your new feature / bug fixes sounds good to us, then we will merge the changes and you are free to delete your branch. - After your contribution is merged, it’s not immediately available to all users. Your change will be shipped as part of the next release. Check the procedure to setup the Development Environment for NativeBase. -**Note:** NativeBase changes a lot and is in constant mutation. We usually merge multiple PRs per day, so sometimes when we are done reviewing, your code might not work with the latest `master` branch anymore. To prevent this, before you make any changes after your code has been reviewed, you should always rebase the latest changes from the `master` branch. +**Note:** NativeBase changes a lot and is in constant mutation. We usually merge multiple PRs per day, so sometimes when we are done reviewing, your code might not work with the latest `v3-dev` branch anymore. To prevent this, before you make any changes after your code has been reviewed, you should always rebase the latest changes from the `v3-dev` branch. ### Working with Git @@ -80,19 +80,19 @@ There are [many](https://git-scm.com/docs/git-reset) to rewrite Git commit history, but we use [interactive rebasing](https://help.github.com/articles/using-git-rebase-on-the-command-line). -First, ensure your local `master` branch contains the latest changes: +First, ensure your local `v3-dev` branch contains the latest changes: ```git -git checkout master +git checkout v3-dev git fetch nativebase -git merge nativebase/master +git merge nativebase/v3-dev ``` Next, invoke Git's rebase tool in interactive mode: ```git git checkout your_branch -git rebase -i master +git rebase -i v3-dev ``` This will open a text editor with a listing of all commits performed in your @@ -100,7 +100,7 @@ feature branch. You'll usually want to `reword` your feature branch's original commit and `fixup` subsequent ones. > You may need to resolve conflicts during the rebase operation. This can occur -> if commits were pushed to `master` while you were working on your +> if commits were pushed to `v3-dev` while you were working on your > contribution. Use `git log` to double-check that your contribution has been squashed into a @@ -155,20 +155,19 @@ You are now ready to send PR to NativeBase! yarn example start ``` - - For Web + - To start app directly on Web ```bash yarn example web ``` - - For IOS + - To start app directly on IOS ```bash yarn example ios ``` - - For Android + - To start app directly on Android ```bash yarn example android ``` - and start making the changes. Happy hacking!