From 1726ff9eef464fe272dc4419eb93668b27688e77 Mon Sep 17 00:00:00 2001 From: Josh Baker Date: Thu, 18 Apr 2019 09:23:41 -0700 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f171642d --- /dev/null +++ b/CONTRIBUTING.md @@ -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!