Add Guidelines

go-vgo · Jan 4, 2017 · 04b67c8 · 04b67c8
1 parent 9296f82
commit 04b67c8
Show file tree

Hide file tree

Showing 4 changed files with 117 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,2 @@
+# Contributing to Robotgo
+
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -0,0 +1,24 @@
+1. Please speak English, this is the language everybody of us can speak and write.
+2. Please ask questions or config/deploy problems on our Gitter channel: https://gitter.im/go-vgo/robotgo ,Not yet supported now.
+3. Please take a moment to search that an issue doesn't already exist.
+4. Please give all relevant information below for bug reports, incomplete details will be handled as an invalid report.
+
+**You MUST delete the content above including this line before posting, otherwise your issue will be invalid.**
+
+- Robotgo version (or commit ref):
+- Go version:
+- Gcc version:
+- Operating system and bit:
+- Can you reproduce the bug at [Example](https://github.com/go-vgo/robotgo/blob/master/example/main.go):
+  - [ ] Yes (provide example code)
+  - [ ] No
+  - [ ] Not relevant
+- Provide example code: 
+    ```Go
+
+    ```
+- Log gist:
+
+## Description
+
+...
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,22 @@
+The pull request will be closed without any reasons if it does not satisfy any of following requirements:
+
+1. Make sure you are targeting the `master` branch, pull requests on release branches are only allowed for bug fixes.
+2. Please read contributing guidelines: https://github.com/go-vgo/robotgo/blob/master/CONTRIBUTING.md
+3. Describe what your pull request does and which issue you're targeting (if any and Please use English)
+4. ... if it is not related to any particular issues, explain why we should not reject your pull request.
+5. The Commits must use English, must be test and No useless submissions.
+**You MUST delete the content above including this line before posting, otherwise your pull request will be invalid.**
+
+**Please provide Issues links to:**
+
+- Issues: #1
+
+**Provide test code:**
+
+    ```Go
+        
+    ```
+
+## Description
+
+...
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,69 @@
+# Contribution Guidelines
+
+## Introduction
+
+This document explains how to contribute changes to the Robotgo project. It assumes you have followed the README.md and [API Document](https://github.com/go-vgo/robotgo/blob/master/doc.md). <!--Sensitive security-related issues should be reported to [security@Robotgo.io](mailto:security@Robotgo.io)-->.
+
+## Bug reports
+
+Please search the issues on the issue tracker with a variety of keywords to ensure your bug is not already reported.
+
+If unique, [open an issue](https://github.com/go-vgo/robotgo/issues/new) and answer the questions so we can understand and reproduce the problematic behavior.
+
+The burden is on you to convince us that it is actually a bug in Robotgo. This is easiest to do when you write clear, concise instructions so we can reproduce the behavior (even if it seems obvious). The more detailed and specific you are, the faster we will be able to help you. Check out [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
+
+Please be kind, remember that Robotgo comes at no cost to you, and you're getting free help.
+
+## Discuss your design
+
+The project welcomes submissions but please let everyone know what you're working on if you want to change or add something to the Robotgo repositories.
+
+Before starting to write something new for the Robotgo project, please [file an issue](https://github.com/go-Robotgo/Robotgo/issues/new). Significant changes must go through the [change proposal process](https://github.com/go-vgo/proposals) before they can be accepted.
+
+This process gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits inside the goals for the project and tools. It also checks that the design is sound before code is written; the code review tool is not the place for high-level discussions.
+
+## Testing redux
+
+Before sending code out for review, run all the tests for the whole tree to make sure the changes don't break other usage and keep the compatibility on upgrade. You must be test on Mac, Windows, Linux and other.
+
+## Code review
+
+Changes to Robotgo must be reviewed before they are accepted, no matter who makes the change even if it is an owner or a maintainer. We use GitHub's pull request workflow to do that and we also use [LGTM](http://lgtm.co) to ensure every PR is reviewed by vz.
+
+
+## Sign your work
+
+The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. 
+
+## Maintainers
+
+To make sure every PR is checked, we got team maintainers.A maintainer should be a contributor of Robotgo and contributed at least 4 accepted PRs. 
+
+## Owners
+
+Since Robotgo is a pure community organization without any company support,Copyright 2016 The go-vgo Project Developers.
+
+
+## Versions
+
+Robotgo has the `master` branch as a tip branch and has version branches such as `v0.30.0`. `v0.40.0` is a release branch and we will tag `v0.40.0` for binary download. If `v0.40.0` has bugs, we will accept pull requests on the `v0.9` branch and publish a `v0.9.1` tag, after bringing the bug fix also to the master branch.
+
+Since the `master` branch is a tip version, if you wish to use Robotgo in production, please download the latest release tag version. All the branches will be protected via GitHub, all the PRs to every branch must be reviewed by two maintainers and must pass the automatic tests.
+
+## Copyright
+
+Code that you contribute should use the standard copyright header:
+
+```
+// Copyright 2016 The go-vgo Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// https://github.com/go-vgo/robotgo/blob/master/LICENSE
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+```
+
+Files in the repository contain copyright from the year they are added to the year they are last changed. If the copyright author is changed, just paste the header below the old one.