xref: /aosp_15_r20/external/javaparser/CONTRIBUTING.md (revision f0340d8e30c177f9125cc02e7b512609509b136e)
1*f0340d8eSSorin Basca## Getting started
2*f0340d8eSSorin BascaHere is some information that's good to know when contributing to JavaParser:
3*f0340d8eSSorin Basca
4*f0340d8eSSorin Basca- There is some interesting information on the [wiki](https://github.com/javaparser/javaparser/wiki).
5*f0340d8eSSorin Basca- 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.
6*f0340d8eSSorin Basca- 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.
7*f0340d8eSSorin Basca- If you're new and like to casually contribute something, check out the [easy issues](https://github.com/javaparser/javaparser/labels/Easy).
8*f0340d8eSSorin Basca- If you're new and would like to become a member, start your own project that uses JavaParser.
9*f0340d8eSSorin BascaWe noticed we get the best feedback from those.
10*f0340d8eSSorin BascaHere are [some fun project ideas](https://github.com/javaparser/javaparser/labels/fun%20project%20idea).
11*f0340d8eSSorin Basca- If you start working on an issue, please say so with a comment in the issue.
12*f0340d8eSSorin Basca- If you know how to fix a problem, please fix it and open a pull request instead of opening an issue.
13*f0340d8eSSorin Basca
14*f0340d8eSSorin BascaThanks for helping!
15*f0340d8eSSorin Basca
16*f0340d8eSSorin Basca## Contribution Workflow
17*f0340d8eSSorin Basca
18*f0340d8eSSorin BascaOur 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.
19*f0340d8eSSorin Basca
20*f0340d8eSSorin Basca1. **Fork** the JavaParser project. If you already have a fork, ensure to fetch the latest commits.
21*f0340d8eSSorin Basca2. 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.
22*f0340d8eSSorin Basca3. When your work in your branch is done, **push your branch to your forked repository**.
23*f0340d8eSSorin Basca4. 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).
24*f0340d8eSSorin Basca
25*f0340d8eSSorin Basca### Remember:
26*f0340d8eSSorin Basca- A pull request should include tests. You can either use BDD ([more information here](https://github.com/javaparser/javaparser/wiki/Testing)) or JUnit.
27*f0340d8eSSorin Basca- Every pull request will automatically be checked by a few tools. Make sure AppVeyor and Travis are green.
28*f0340d8eSSorin Basca- Pull requests often stay open for at least a few days to give people a chance to review it.
29*f0340d8eSSorin Basca- A pull request is merged when all comments on it have been resolved.
30*f0340d8eSSorin Basca- If you create a pull request for an issue, mention the issue in the format #123 to make github link it automatically.
31