aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJeanderson Barros Candido <jeandersonbc@gmail.com>2017-01-19 09:21:09 -0300
committerJeanderson Candido <jeandersonbc@gmail.com>2017-01-19 09:23:37 -0300
commit66589b9e8a04bcb462aac2b93a4a9227c565b46d (patch)
treea537da17208b88c0cb61e88e4439dc202af7d5ce /CONTRIBUTING.md
parent5945f4de46c7495e9a120e3d439d73b8be1500a0 (diff)
downloadjavaparser-66589b9e8a04bcb462aac2b93a4a9227c565b46d.tar.gz
Minor formatting updates
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md28
1 files changed, 14 insertions, 14 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4d310d4a7..16870829f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,12 @@
## Getting started
Here is some information that's good to know when contributing to JavaParser:
-- there is some interesting information on the [wiki](https://github.com/javaparser/javaparser/wiki).
-- we work on JavaParser because we like to, not because it earns us money. Please remember that we try to run a professional project in our spare time, on a budget of zero.
-- be sure to check [the coding guidelines](https://github.com/javaparser/javaparser/wiki/Coding-Guidelines) which are easily used by installing the formatting rules as described there.
-- if you're new and like to contribute something, check out the [easy issues](https://github.com/javaparser/javaparser/labels/Easy).
-- if you start working on an issue, please say so with a comment in the issue.
-- if you know how to fix a problem, please fix it and open a pull request instead of opening an issue.
+- There is some interesting information on the [wiki](https://github.com/javaparser/javaparser/wiki).
+- We work on JavaParser because we like to, not because it earns us money. Please remember that we try to run a professional project in our spare time, on a budget of zero.
+- Be sure to check [the coding guidelines](https://github.com/javaparser/javaparser/wiki/Coding-Guidelines) which are easily used by installing the formatting rules as described there.
+- If you're new and like to contribute something, check out the [easy issues](https://github.com/javaparser/javaparser/labels/Easy).
+- If you start working on an issue, please say so with a comment in the issue.
+- If you know how to fix a problem, please fix it and open a pull request instead of opening an issue.
Thanks for helping!
@@ -14,14 +14,14 @@ Thanks for helping!
Our development workflow is based on Pull Request. If you are not familiar with the Pull Requests, we suggest you to checkout the [Github Documentation](https://help.github.com/articles/creating-a-pull-request/) for more information.
-1. **Fork** the JavaParser project. If you already have a fork, ensure to fetch the latest commits)
+1. **Fork** the JavaParser project. If you already have a fork, ensure to fetch the latest commits.
2. In your forked project, **create a branch** related to the issue you are working on. This is important to ensure that your pull request will not contain unrelated work.
-3. When your work in your branch is done, **push your branch to your forked repository**
-4. Go back to the [javaparser project site](https://github.com/javaparser/javaparser) and it should have a message offering to **create a pull request**. (If it doesn't you can [create one manually](https://github.com/javaparser/javaparser/compare).)
+3. When your work in your branch is done, **push your branch to your forked repository**.
+4. Go back to the [javaparser project site](https://github.com/javaparser/javaparser) and it should have a message offering to **create a pull request**. If it doesn't you can [create one manually](https://github.com/javaparser/javaparser/compare).
### Remember:
-- a pull request should include tests. You can either use BDD ([more information here](https://github.com/javaparser/javaparser/wiki/Testing)) or JUnit.
-- every pull request will automatically be checked by a few tools. Make sure AppVeyor and Travis are green.
-- pull requests often stay open for at least a few days to give people a chance to review it.
-- a pull request is merged when all comments on it have been resolved.
-- if you create a pull request for an issue, mention the issue in the format #123 to make github link it automatically.
+- A pull request should include tests. You can either use BDD ([more information here](https://github.com/javaparser/javaparser/wiki/Testing)) or JUnit.
+- Every pull request will automatically be checked by a few tools. Make sure AppVeyor and Travis are green.
+- Pull requests often stay open for at least a few days to give people a chance to review it.
+- A pull request is merged when all comments on it have been resolved.
+- If you create a pull request for an issue, mention the issue in the format #123 to make github link it automatically.