Regular update

Author: JarryShaw

AUTHORS.md

@@ -0,0 +1,7 @@
+# Authors
+
+This list is sorted by the number of commits per contributor in descending order.
+
+* [@JarryShaw](https://github.com/JarryShaw)
+
+###### Auto generated by [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2018-12-06

CONTRIBUTING.md

@@ -1,28 +1,65 @@
-How to Contribute
-=================
-
-  The `f2format` project is an open source Python program focus on
-conversion between *f-string* and `str.format`.
-
-Pull Requests
--------------
-
-1. Pull requests are welcome. If you would like to add a large feature
-   or make a significant change, make sure to open an issue to discuss
-   with other people first.
-2. Follow PEP8.
-3. Make sure to pass the unit tests. Write unit tests for new modules if
-   needed.
-
-Issues
-------
-
-1. Only bugs and feature requests are accepted here.
-2. Shall only work on important features. If the feature you're asking
-   only benefits a few people, you'd better implement the featur
-   yourself and send us a pull request, or ask some of your friends to
-   do so.
-3. Don't answer questions of any other types here, but tips and some
-   troubleshooting on Python can be found here.
-4. Issues in languages other than English and Chinese will be Google
-   translated into English later.
+# How to contribute
+
+This document outlines some of the conventions on development workflow, commit message formatting, contact points and other
+resources to make it easier to get your contribution accepted.
+
+## Getting started
+
+- Fork the repository on GitHub.
+- Read the README.md for build instructions.
+- Play with the project, submit bugs, submit patches!
+
+## Contribution flow
+
+This is a rough outline of what a contributor's workflow looks like:
+
+- Create a topic branch from where you want to base your work. This is usually master.
+- Make commits of logical units and add test case if the change fixes a bug or adds new functionality.
+- Run tests and make sure all the tests are passed.
+- Make sure your commit messages are in the proper format (see below).
+- Push your changes to a topic branch in your fork of the repository.
+- Submit a pull request to the repo.
+
+Thanks for your contributions!
+
+## Coding Style
+
+See the [Python style doc](https://www.python.org/dev/peps/pep-0008/) for details.
+
+### Format of the Commit Message
+
+We follow a rough convention for commit messages that is designed to answer two
+questions: what changed and why. The subject line should feature the what and
+the body of the commit should describe the why.
+
+<pre><code>
+store/localstore: add comment for variable declaration.
+
+Improve documentation.
+</code></pre>
+
+The format can be described more formally as follows:
+
+<pre><code>
+subsystem: what changed
+BLANK LINE
+why this change was made
+BLANK LINE
+footer(optional)
+</code></pre>
+
+The first line is the subject and should be no longer than 70 characters, the
+second line is always blank, and other lines should be wrapped at 80 characters.
+This allows the message to be easier to read on GitHub as well as in various
+git tools.
+
+If the change affects more than one subsystem, you can use comma to separate them like util/codec,util/types:.
+
+If the change affects many subsystems, you can use * instead, like *:.
+
+For the why part, if no specific reason for the change,
+you can use one of some generic reasons like "Improve documentation.",
+"Improve performance.", "Improve robustness.", "Improve test coverage."
+
+
+###### Auto generated by [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2018-12-06