cutter/CONTRIBUTING.md

26 lines
1.5 KiB
Markdown
Raw Normal View History

2017-10-03 18:55:50 +00:00
# Contributing to Cutter
2018-10-17 21:07:34 +00:00
There are different ways you can help contributing to Cutter:
2017-10-03 18:55:50 +00:00
## Opening an issue
Make a clear description of the bug/feature, use screenshots, send binaries, etc.
2018-10-17 21:07:34 +00:00
This will help us improve the software for you.
You can create an issue by clicking on [this link](https://github.com/radareorg/cutter/issues/new/choose).
2017-10-03 18:55:50 +00:00
## Contributing to the code
Note that cutter is still under development and many parts of the code are to be improved.
2018-10-17 21:07:34 +00:00
The best way is to check the opened issues [here](https://github.com/radareorg/cutter/issues) or discuss with radareorg team.
Please follow our contribution guidelines: https://cutter.re/docs/developers-docs.html
2017-10-03 18:55:50 +00:00
2018-10-17 21:07:34 +00:00
## Contributing to the documentation
2018-03-21 20:32:32 +00:00
The documentation is something important for newcomers. As of today the documentation can be found [here](https://cutter.re/docs/) and it stands in the [docs](https://github.com/radareorg/cutter/tree/master/docs) folder.
The API Reference is automatically generated from the source code, so it is strongly advised to document your code.
2018-10-17 21:07:34 +00:00
Check issues marked as "Documentation" on our issues [list](https://github.com/radareorg/cutter/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation).
## Translations
You can help Cutter by adding translations to the project! We use the [Crowdin](https://crowdin.com/project/cutter) platform to help us share translations. Feel free to contribute and add translations to the project. If you need to add a language, ask any radareorg developer.