mirror of
https://github.com/rizinorg/cutter.git
synced 2024-12-18 19:06:10 +00:00
26 lines
1.4 KiB
Markdown
26 lines
1.4 KiB
Markdown
# Contributing to Cutter
|
|
|
|
There are different ways you can help contributing to Cutter:
|
|
|
|
## Opening an issue
|
|
|
|
Make a clear description of the bug/feature, use screenshots, send binaries, etc.
|
|
This will help us improve the software for you.
|
|
You can create an issue by clicking on [this link](https://github.com/rizinorg/cutter/issues/new/choose).
|
|
|
|
## Contributing to the code
|
|
|
|
Note that cutter is still under development and many parts of the code are to be improved.
|
|
The best way is to check the opened issues [here](https://github.com/rizinorg/cutter/issues) or discuss with rizinorg team.
|
|
Please follow our contribution guidelines: https://cutter.re/docs/contributing.html
|
|
|
|
## Contributing to the documentation
|
|
|
|
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](docs) folder.
|
|
The API Reference is automatically generated from the source code, so it is strongly advised to document your code.
|
|
Check issues marked as "Documentation" on our issues [list](https://github.com/rizinorg/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 rizinorg developer.
|