Skip to content

Commit cd2dfd1

Browse files
authored
Merge pull request alibaba#2438 from nschaffner/master
Update README.md
2 parents 003d3f0 + 8a0e62b commit cd2dfd1

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
## Contributing
3+
4+
If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.
5+
6+
### How to make a clean pull request
7+
8+
Look for a project's contribution instructions. If there are any, follow them.
9+
10+
- Create a personal fork of the project on Github.
11+
- Clone the fork on your local machine. Your remote repo on Github is called `origin`.
12+
- Add the original repository as a remote called `upstream`.
13+
- If you created your fork a while ago be sure to pull upstream changes into your local repository.
14+
- Create a new branch to work on! Branch from `develop` if it exists, else from `master`.
15+
- Implement/fix your feature, comment your code.
16+
- Follow the code style of the project, including indentation.
17+
- If the project has tests run them!
18+
- Write or adapt tests as needed.
19+
- Add or change the documentation as needed.
20+
- Create a new branch if necessary.
21+
- Push your branch to your fork on Github, the remote `origin`.
22+
- From your fork open a pull request in the correct branch. Target the project's `develop` branch if there is one, else go for `master`!
23+
- Wait for approval.
24+
- Once the pull request is approved and merged you can pull the changes from `upstream` to your local repo and delete
25+
your extra branch(es).
26+
27+
And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Fastjson is a Java library that can be used to convert Java Objects into their J
2121
## Documentation
2222

2323
- [Documentation Home](https://github.com/alibaba/fastjson/wiki)
24+
- [Contributing Code](https://github.com/nschaffner/fastjson/blob/master/CONTRIBUTING.md)
2425
- [Frequently Asked Questions](https://github.com/alibaba/fastjson/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)
2526

2627
## Benchmark

0 commit comments

Comments
 (0)