Skip to content

Commit f57c468

Browse files
authored
Create CONTRIBUTING.md
1 parent 1c4a4e4 commit f57c468

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/advanced-security/SARIF-viewer/fork
4+
[pr]: https://github.com/advanced-security/SARIF-viewer/compare
5+
[code-of-conduct]: CODE_OF_CONDUCT.md
6+
7+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
8+
9+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).
10+
11+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
12+
13+
## Prerequisites for running and testing code
14+
15+
These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
16+
17+
1. ./gradlew build
18+
19+
## Submitting a pull request
20+
21+
1. [Fork][fork] and clone the repository
22+
1. Configure and install the dependencies
23+
1. Make sure the tests pass on your machine: `./gradlew test`
24+
1. Create a new branch: `git checkout -b my-branch-name`
25+
1. Make your change, add tests, and make sure the tests and linter still pass
26+
1. Push to your fork and [submit a pull request][pr]
27+
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
28+
29+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
30+
31+
- Write tests.
32+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
33+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
34+
35+
## Resources
36+
37+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
38+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
39+
- [GitHub Help](https://help.github.com)

0 commit comments

Comments
 (0)