mirror of https://github.com/tidwall/tile38.git
26 lines
1.7 KiB
Markdown
26 lines
1.7 KiB
Markdown
|
## How to contribute to Tile38
|
||
|
|
|
||
|
|
Before getting starting with contributing, please know that we currently use [Tile38 Slack](https://tile38.com/slack) channel for casual questions and user chat.
|
||
|
|
|
||
|
|
### Did you find a bug?
|
||
|
|
|
||
|
|
- **Do not open up a GitHub issue if the bug is a security vulnerability in Tile38**. Sensitive security-related issues should be reported to [security@tile38.com](mailto:security@tile38.com).
|
||
|
|
|
||
|
|
- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/tidwall/tile38/issues).
|
||
|
|
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/tidwall/tile38/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
|
||
|
|
|
||
|
|
### Did you write a patch that fixes a bug?
|
||
|
|
|
||
|
|
- Open a new GitHub pull request with the patch.
|
||
|
|
- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
|
||
|
|
|
||
|
|
### Did you fix whitespace, format code, or make a purely cosmetic patch?
|
||
|
|
|
||
|
|
Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Tile38 will generally not be accepted.
|
||
|
|
|
||
|
|
### Do you intend to add a new feature or change an existing one?
|
||
|
|
|
||
|
|
- Suggest your change in [a new issue](https://github.com/tidwall/tile38/issues/new) or in the [Tile38 Slack](https://tile38.com/slack), and start writing code.
|
||
|
|
- Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
|
||
|
|
|
||
|
|
Thanks!
|