Skip to content

Commit e6c3999

Browse files
committed
Adding in new changes to CONTRIBUTING.md
Signed-off-by: James Sutton <james.sutton@uk.ibm.com> Changing some formatting on Contributing.md Signed-off-by: James Sutton <james.sutton@uk.ibm.com>
1 parent 1e3cd8b commit e6c3999

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,18 @@ Please read the [Eclipse Foundation policy on accepting contributions via Git](h
2020

2121
## Contributing a change
2222

23-
1. Fork the repository on GitHub
24-
2. Clone the forked repository onto your computer: ``` git clone https://github.com/eclipse/paho.mqtt.java.git ```
25-
3. Checkout the remote ```develop``` branch: ``` git checkout -b develop remotes/origin/develop ```
23+
## Contributing a change
24+
25+
1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt.java/fork)
26+
2. Clone the forked repository onto your computer: ``` git clone https://github.com/<your username>/paho.mqtt.java.git ```
27+
3. Create a new branch from the latest ```develop``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/develop```
2628
4. Make your changes
2729
5. If developing a new feature, make sure to include JUnit tests.
28-
6. Ensure that all tests pass.
30+
6. Ensure that all new and existing tests pass.
2931
7. Commit the changes into the branch: ``` git commit -s ``` Make sure that your commit message is meaningful and describes your changes correctly.
30-
8. If you have a lot of commits for the change, squash them into a single commit.
31-
9. Push the changes to the develop branch in your forked repository.
32-
10. Finally, submit a pull request using the normal GitHub Web Interface.
32+
8. If you have a lot of commits for the change, squash them into a single / few commits.
33+
9. Push the changes in your branch to your forked repository.
34+
10. Finally, go to [https://github.com/eclipse/paho.mqtt.java](https://github.com/eclipse/paho.mqtt.java) and create a pull request from your "YOUR_BRANCH_NAME" branch to the ```develop``` one to request review and merge of the commits in your pushed branch.
3335

3436

3537
What happens next depends on the content of the patch. If it is 100% authored
@@ -63,4 +65,4 @@ Create a new bug:
6365

6466
Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!
6567

66-
- [Create new Paho bug](https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Paho)
68+
- [Create new Paho bug](https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Paho)

0 commit comments

Comments
 (0)