mirror
/
tile38
mirror of https://github.com/tidwall/tile38.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Create CONTRIBUTING.md

This commit is contained in:
Josh Baker 2019-04-18 09:23:41 -07:00 committed by GitHub
parent 3f34706f24
commit 1726ff9eef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,48 @@
## How to contribute to Tile38
> Hi Everyone,
>
> Before getting starting with contributing, please know that we currently have two community forums.
>
> - [Tile38 Mailing List](https://groups.google.com/forum/?fromgroups#!forum/tile38) for technical user questions, feature requests, and developers.
> - [Tile38 Slack](https://tile38.com/slack) for casual questions and user chat.
>
> The mailing list is brand new as of April 18, 2019.
>
> Thanks,
> Josh Baker
#### 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 the [tile38 mailing list](https://groups.google.com/forum/?fromgroups#!forum/tile38), 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.
#### **Do you have questions about the source code?**
* Ask any question about how to use Tile38 in the [tile38 mailing list](https://groups.google.com/forum/?fromgroups#!forum/tile38).
Thanks!