doc: upload contributing document and update (#197)

2020-07-11 19:23:18 +10:00 · 2020-07-11 19:23:18 +10:00 · 69e26336c6
commit 69e26336c6
parent cfa90ac7f4
3 changed files with 129 additions and 14 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,78 @@
+# Contributing to this library are always welcome and highly encouraged :)
+
+This is a guide for you to get some ideas~
+
+## Dependencies
+
+To make sure that the following instructions work, please install the following dependencies
+on you machine:
+
+- coveralls==1.1
+
+## Installation
+
+To get the source of `py-googletrans`, clone the git repository via:
+
+````
+$ git clone https://github.com/ssut/py-googletrans
+````
+This will clone the complete source to your local machine.
+
+## Issue Reporting
+
+Feel free to report any issues that you come up with!
+Please follow the steps before reporting. We love keeping everything in a good manner :p
+
+### Step 1: Checking Previous Issues
+
+There may be a lot of different issues related to different aspects.  
+Here we list 12 main types:  
+
+* [bug](https://github.com/ssut/py-googletrans/labels/bug)
+* [compromised](https://github.com/ssut/py-googletrans/labels/compromised)
+* [dependices](https://github.com/ssut/py-googletrans/labels/dependices)
+* [duplicate](https://github.com/ssut/py-googletrans/labels/duplicate)
+* [enhancement](https://github.com/ssut/py-googletrans/labels/enhancement)
+* [help wanted](https://github.com/ssut/py-googletrans/labels/help%20wanted)
+* [in progress](https://github.com/ssut/py-googletrans/labels/help%20wanted)
+* [invalid](https://github.com/ssut/py-googletrans/labels/invalid)  
+
+Please see [About labels](https://docs.github.com/en/github/managing-your-work-on-github/about-labels) for more information.  
+
+Note there is no labels for closed issues but still remember to have a look!  
+
+### Step 2: Formating Your Comment
+
+Inspired by [ionic-framework](https://github.com/ionic-team/ionic-framework/blob/master/.github/ISSUE_TEMPLATE.md).  
+Please see the [Issue Template](ISSUE_TEMPLATE.md).
+
+## Pull Request Submitting
+
+Inspired by [angular-translate](https://github.com/angular-translate/angular-translate/blob/master/CONTRIBUTING.md).  
+- Check out a new branch based on <code>master</code> and name it to what you intend to do:
+  - Example:
+    ````
+    $ git checkout -b BRANCH_NAME origin/master
+    ````
+    If you get an error, you may need to fetch master first by using
+    ````
+    $ git remote update && git fetch
+    ````
+  - Use one branch per fix/feature
+- Make your changes
+  - Make sure to provide a spec for unit tests.
+  - Run the tests ``pytest``.
+  - Add a test for your feature or bug fix.
+  - When all tests pass, everything's fine. If your changes are not 100% covered, go back and 
+    run the tests ``pytest`` again
+- Commit your changes
+  - Please provide a git message that explains what you've done.
+  - Please make sure your commits follow the [conventions](https://www.conventionalcommits.org/en/v1.0.0/)
+  - Commit to the forked repository.
+- Make a pull request
+  - Make sure you send the PR to the <code>master</code> branch.
+  - Link the bug issue if there is one.
+  - Travis CI is watching you!
+
+If you follow these instructions, your PR will land pretty safely in the main repo!  
+  
--- a/ISSUE_TEMPLATE.md
+++ b/ISSUE_TEMPLATE.md
@ -0,0 +1,47 @@
+<!-- Before submitting an issue, please consult our docs (https://py-googletrans.readthedocs.io/en/latest/) -->
+
+<!-- Please make sure you are posting an issue pertaining to Googletrans. -->
+
+<!-- Please try not to submit support requests of personal needs. We want to keep the library in a simple way. -->
+
+<!-- ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION. -->
+
+**Googletrans version:**
+[x] **3.x**
+[ ] **2.x**
+
+**I'm submitting a ...** 
+<!--  (check one with "x") -->
+[ ] bug report
+[ ] feature request
+
+<!-- Please try not to submit support requests of personal needs. We want to keep the library in a simple way. -->
+
+**Current behavior:**
+<!-- Describe how the bug manifests. -->
+
+**Expected behavior:**
+<!-- Describe what the behavior would be without the bug. -->
+
+**Steps to reproduce:**
+<!--  Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
+
+**Related code:**
+
+<!-- If you are able to illustrate the bug or feature request with an example, please provide a sample application via one of the following means:
+
+-->
+
+```
+insert short code snippets here
+```
+
+**Other information:**
+<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->
+
+**Googletrans info:** 
+<!-- (run `ionic info` from a terminal/cmd prompt and paste output below): -->
+
+```
+insert the output from ionic info here
+```
--- a/README.rst
+++ b/README.rst
@ -191,23 +191,13 @@ This library follows `Semantic Versioning <http://semver.org/>`__ from
 v2.0.0. Any release versioned 0.x.y is subject to backwards incompatible
 changes at any time.

-Submitting a Pull Request
+Contributing
 -------------------------

-Contributions to this library are always welcome and highly encouraged
-:)
+Contributions are more than welcomed. See  
+[CONTRIBUTING.md](CONTRIBUTING.md)

-1. Fork this project.
-2. Create a topic branch.
-3. Implement your feature or bug fix.
-4. Run ``pytest``.
-5. Add a test for your feature or bug fix.
-6. Run step 4 again. If your changes are not 100% covered, go back to
-   step 5.
-7. Commit and push your changes.
-8. Submit a pull request.
-
--------------
+-----------------------------------------

 License
 -------