Skip to content

Commit f267355

Browse files
Merge pull request #196 from frg-fossee/firuza-patch-1
update branch info in CONTRIBUTING.md
2 parents d627695 + b8b528a commit f267355

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,16 @@ If you just want to report a bug in our system or want to suggest a new feature
3232
* An inactivity of over 3 weeks in your repo or no discussion on Discord, without prior intimation, will be considered that you are no longer interested. In such a case the assignee name will be removed so that the issue can be solved by someone else. You are however free to assign it to yourself again when you are available, if the issue is not assigned to someone else.
3333

3434
## Step 2: Fork Repository
35-
* The first step is to fork the repository so that you have your own repository on which you can work on.
36-
* You must then identify the branch on which you would like to contribute. You are free to work on the existing branch, however, we recommend that you create a new branch (feature or bugfix) from the desired existing branch and work on the newly created branch. This way if we make some changes to the branch in our repo, you can upstream it at anytime for maintaining the updated codebase.
35+
* The first step is to fork the repository so that you have your own repository in which you can work on.
36+
* Create a **new branch** (feature or bugfix) from the **Develop** branch and work on the newly created branch. This way if we make some changes to the Develop branch in our repo, you can upstream it at anytime for maintaining the updated codebase.
3737

3838
## Step 3: Contribute
39-
* Once the branch is chosen or created, you can start contributing (coding, documentation, test cases, etc.). Make sure that you follow the [contributing guidelines](https://esim-cloud.readthedocs.io/en/latest/contribute/ContributingGuidelines.html).
39+
* Once the branch created, you can start contributing (coding, documentation, test cases, etc.). Make sure that you follow the [contributing guidelines](https://esim-cloud.readthedocs.io/en/latest/contribute/ContributingGuidelines.html).
4040
* We use GitHub Actions for continuous integrations that runs linting and testing operations.
4141
* There might be some changes to the original repository which will not reflect in your forked repository automatically. If you want to update it, sync it using the steps given in the link: https://help.github.com/articles/syncing-a-fork/
4242

4343
## Step 4: Make a pull request
44-
* When you feel that you are ready to merge your contributions into our repository, create a pull request.
44+
* When you feel that you are ready to merge your contributions into our repository, create a pull request **from your feature/bugfix branch to our Develop** branch.
4545
* Select an appropriate label from the list E.g. enhancement, bug fix, etc.
4646
* Please go through the [pull request guidelines](https://esim-cloud.readthedocs.io/en/latest/contribute/PullRequest.html).
4747
* Our reviewing team will review your pull request made and will interact with you by posting comments. You may be asked to modify incase there is any issue.

0 commit comments

Comments
 (0)