radare2/CONTRIBUTING.md

38 lines
1.6 KiB
Markdown
Raw Normal View History

2015-09-22 11:56:07 +00:00
# How to report issues
Before reporting an issue with GitHub, be sure that:
* you are using the git version of radare2
* you are using a clean installation
* the issue was not already reported
When the above conditions are satisfied, feel free to submit an issue,
2015-09-22 11:56:07 +00:00
trying to be as precise as possible. If you can, provide the problematic
binary, the steps to reproduce the error and a backtrace in case of SEGFAULTs.
Any information will help to fix the problem.
# How to contribute
There are a few guidelines that we need contributors to follow so that we can
try to keep the codebase consistent and clean.
## Getting Started
* Make sure you have a GitHub account.
* Fork the repository on GitHub.
* Create a topic branch from master. Please avoid working directly on the ```master``` branch.
2017-12-13 09:15:22 +00:00
* Make commits of logical units.
2015-09-22 11:56:07 +00:00
* Check for unnecessary whitespace with ```git diff --check``` and be sure to follow the CODINGSTYLE (more on this in the next section).
* Submit the Pull Request(PR) on Github.
* When relevant, write a test for
[radare2-regressions](https://github.com/radare/radare2-regressions) and
submit a PR also there. Use the same branch name in both repositories, so
Travis will be able to use your new tests together with new changes.
AppVeyor (for now) still uses radare/radare2-regressions repo with branch
master. NOTE: when merging PRs, *always* merge the radare2-regressions PR
first.
2015-09-22 11:56:07 +00:00
# Additional resources
* [README.md](https://github.com/radare/radare2/blob/master/README.md)
* [DEVELOPERS.md](https://github.com/radare/radare2/blob/master/DEVELOPERS.md)