Skip to content

Commit 76e2d70

Browse files
committed
No licence on plugin config files
1 parent e38c5e7 commit 76e2d70

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ cd oshi
1414
git remote add upstream https://github.com/oshi/oshi.git
1515
```
1616

17-
#### Create a Topic Branch
17+
#### Create a Branch for your feature
1818

1919
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
2020

@@ -34,7 +34,8 @@ mvn test
3434

3535
#### Write Tests
3636

37-
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
37+
For bug fixes, try to write a test that reproduces the problem you're trying to fix (and fails).
38+
For new features, write a test that produces results for a feature that you want to build.
3839

3940
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
4041

@@ -44,9 +45,6 @@ Implement your feature or bug fix.
4445

4546
Make sure that `mvn test` completes without errors.
4647

47-
#### Write Documentation
48-
49-
Document any external behavior in the [README](README.md).
5048

5149
#### Update Changelog
5250

@@ -76,11 +74,11 @@ git push origin my-feature-branch
7674

7775
#### Make a Pull Request
7876

79-
Go to https://github.com/contributor/oshi and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
77+
Go to https://github.com/yournamehere/oshi and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
8078

8179
#### Rebase
8280

83-
If you've been working on a change for a while, rebase with upstream/master.
81+
If you've been working on a change for a while and other commits have been made to the project, rebase with upstream/master.
8482

8583
```
8684
git fetch upstream
@@ -96,7 +94,7 @@ Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical ent
9694
* [#123](https://github.com/oshi/oshi/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
9795
```
9896

99-
Amend your previous commit and force push the changes.
97+
You may amend your previous commit and force push the changes, or just submit a changelog commit.
10098

10199
```
102100
git commit --amend
@@ -105,7 +103,9 @@ git push origin my-feature-branch -f
105103

106104
#### Check on Your Pull Request
107105

108-
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
106+
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI.
107+
Everything should look green, otherwise read the Travis log to identify failed tests or compile erros.
108+
Fix issues and amend your commit as described above.
109109

110110
#### Be Patient
111111

pom.xml

+1
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,7 @@
496496
<exclude>mvnw.cmd</exclude>
497497
<exclude>LICENSE_*</exclude>
498498
<exclude>**/OSHIJavaFormatConventions.xml</exclude>
499+
<exclude>**/issue_label_bot.yaml</exclude>
499500
</excludes>
500501
</configuration>
501502
</plugin>

0 commit comments

Comments
 (0)