radare2/CONTRIBUTING.md

# 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
while 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.
* Make commits of logical units.
* Check for coding style issues with ```git diff master..mybranch | ./sys/clang-format-diff.py -p1``` and be sure to follow the CODINGSTYLE (more on this in [DEVELOPERS.md](https://github.com/radareorg/radare2/blob/master/DEVELOPERS.md)).
* Submit the Pull Request(PR) on Github.
* When relevant, write a test in [test/](test).

# Additional resources

* [README.md](https://github.com/radareorg/radare2/blob/master/README.md)
* [DEVELOPERS.md](https://github.com/radareorg/radare2/blob/master/DEVELOPERS.md)
CONTRIBUTING.md: first version 2015-09-22 19:56:07 +08: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`

Grammar edits to README.md (#11713) * Fixes a couple of grammar mistakes in AUTHORS.md * Grammar fix in CONTRIBUTING.md * Fixes multiple grammar errors in DEVELOPERS.md * Caps the character length in a edit I made. 2018-10-02 21:23:59 +08:00			`When the above conditions are satisfied, feel free to submit an issue`
			`while trying to be as precise as possible. If you can, provide the problematic`
CONTRIBUTING.md: first version 2015-09-22 19:56:07 +08:00			`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.
Fix typo in CONTRIBUTING.md 2017-12-13 17:15:22 +08:00			`* Make commits of logical units.`
Change radare->radareorg links 2019-10-07 16:44:21 +08:00			* Check for coding style issues with ```git diff master..mybranch \| ./sys/clang-format-diff.py -p1``` and be sure to follow the CODINGSTYLE (more on this in [DEVELOPERS.md](https://github.com/radareorg/radare2/blob/master/DEVELOPERS.md)).
CONTRIBUTING.md: first version 2015-09-22 19:56:07 +08:00			`* Submit the Pull Request(PR) on Github.`
Imports Tests from radare2-regressions (#15546) 2019-12-08 22:31:14 +08:00			`* When relevant, write a test in [test/](test).`
CONTRIBUTING.md: first version 2015-09-22 19:56:07 +08:00
			`# Additional resources`

Change radare->radareorg links 2019-10-07 16:44:21 +08:00			`* [README.md](https://github.com/radareorg/radare2/blob/master/README.md)`
			`* [DEVELOPERS.md](https://github.com/radareorg/radare2/blob/master/DEVELOPERS.md)`