Merge pull request #238 from alibaba/readme-develop
Enrich the content of CONTRIBUTING
This commit is contained in:
Penn(PingGuo)
GitHub
commit
431ccc6fe1
73
CODE_OF_CONDUCT.md
Normal file
73
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,73 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
education, socio-economic status, nationality, personal appearance, race,
|
||||
religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at users-nacos@googlegroups.com. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
@ -1,31 +1,72 @@
|
||||
## How To Contribute
|
||||
# Contributing to Nacos
|
||||
|
||||
We are always very happy to have contributions, whether for trivial cleanups or big new features.
|
||||
We want to have high quality, well documented codes for each programming language.
|
||||
Welcome to Nacos! This document is a guideline about how to contribute to Nacos.
|
||||
If you find something incorrect or missing, please leave comments / suggestions.
|
||||
|
||||
Nor is code the only way to contribute to the project. We strongly value documentation, integration with other project, and gladly accept improvements for these aspects.
|
||||
## Before you get started
|
||||
|
||||
## Contributing code
|
||||
### Code of Conduct
|
||||
|
||||
To submit a change for inclusion, please do the following:
|
||||
Please make sure to read and observe our [Code of Conduct](./CODE_OF_CONDUCT.md).
|
||||
|
||||
#### If the change is non-trivial please include some unit tests that cover the new functionality.
|
||||
#### If you are introducing a completely new feature or API it is a good idea to start a wiki and get consensus on the basic design first.
|
||||
#### It is our job to follow up on patches in a timely fashion. Nag us if we aren't doing our job (sometimes we drop things).
|
||||
|
||||
## Becoming a Committer
|
||||
## Contributing
|
||||
|
||||
We are always interested in adding new contributors. What we look for are series of contributions, good taste and ongoing interest in the project. If you are interested in becoming a committer, please let one of the existing committers know and they can help you walk through the process.
|
||||
We are always very happy to have contributions, whether for typo fix, bug fix or big new features.
|
||||
Please do not ever hesitate to ask a question or send a pull request.
|
||||
|
||||
Nowadays,we have several important contribution points:
|
||||
#### Wiki & JavaDoc
|
||||
#### Nacos Console
|
||||
#### Nacos SDK(C++\.Net\Php\Python\Go\Node.js)
|
||||
We strongly value documentation and integration with other projects such as Spring Cloud, Kubernetes, Dubbo, etc.
|
||||
We are very glad to accept improvements for these aspects.
|
||||
|
||||
##### Prerequisite
|
||||
If you want to contribute the above listing points, you must abide our some prerequisites:
|
||||
|
||||
###### Readability - API must have Javadoc,some very important methods also must have javadoc
|
||||
###### Testability - 80% above unit test coverage about main process
|
||||
###### Maintainability - Comply with our [PMD spec](style/codeStyle.xml), and at least 3 month update frequency
|
||||
###### Deployability - We encourage you to deploy into [maven repository](http://search.maven.org/)
|
||||
### Open an issue / PR
|
||||
|
||||
We use [GitHub Issues](https://github.com/alibaba/Nacos/issues) and [Pull Requests](https://github.com/alibaba/Nacos/pulls) for trackers.
|
||||
|
||||
If you find a typo in document, find a bug in code, or want new features, or want to give suggestions,
|
||||
you can [open an issue on GitHub](https://github.com/alibaba/Nacos/issues/new) to report it.
|
||||
Please follow the guideline message in the issue template.
|
||||
|
||||
If you want to contribute, please follow the [contribution workflow](#github-workflow) and create a new pull request.
|
||||
If your PR contains large changes, e.g. component refactor or new components, please write detailed documents
|
||||
about its design and usage.
|
||||
|
||||
If you just want to contribute directly
|
||||
|
||||
### Begin yoru development
|
||||
|
||||
We use the `develop` branch as the development branch, which indicates that this is a unstable branch.
|
||||
|
||||
Here is the workflow for contributors:
|
||||
|
||||
1. Fork to your own
|
||||
2. Clone fork to local repository
|
||||
3. Create a new branch and work on it
|
||||
4. Keep your branch in sync
|
||||
5. Commit your changes (make sure your commit message concise)
|
||||
6. Push your commits to your forked repository
|
||||
7. Create a pull request.
|
||||
|
||||
When creating pull request:
|
||||
|
||||
1. Please follow [the pull request template](./.github/PULL_REQUEST_TEMPLATE.md).
|
||||
2. Please make sure the PR has a corresponding issue.
|
||||
3. If your PR contains large changes, e.g. component refactor or new components, please write detailed documents
|
||||
about its design and usage.
|
||||
4. Note that a single PR should not be too large. If heavy changes are required, it's better to separate the changes
|
||||
to a few individual PRs.
|
||||
5. After creating a PR, one or more reviewers will be assigned to the pull request.
|
||||
6. Before merging a PR, squash any fix review feedback, typo, merged, and rebased sorts of commits.
|
||||
The final commit message should be clear and concise.
|
||||
|
||||
### Code review guidance
|
||||
|
||||
Our PMC will rotate reviewing the code to make sure all the PR will be reviewed timely and by at least one committer before merge. If we aren't doing our job (sometimes we drop things). And as always, we welcome volunteers for code review.
|
||||
|
||||
Some principles:
|
||||
|
||||
- Readability - Important code should be well-documented. API should have Javadoc. Code style should be complied with the existing one.
|
||||
- Elegance: New functions, classes or components should be well designed.
|
||||
- Testability - 80% of the new code should be covered by unit test cases.
|
||||
- Maintainability - Comply with our [PMD spec](style/codeStyle.xml), and 3-month-frequency update should be maintained at least.
|
||||
|
||||
|
||||
12
README.md
12
README.md
@ -77,10 +77,7 @@ You can view the full documentation from the [Nacos website](https://nacos.io/en
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributors are welcome to join Nacos project.
|
||||
|
||||
- Contributing guide (constructing): describe general contributing procedure for Nacos project, such as issue submitting, milestone plan, etc.
|
||||
- Developing guide (constructing): describe detailed developing procedure including how to fork, choosing correct branch, PR review procedure, etc.
|
||||
Contributors are welcomed to join Nacos project. Please check [CONTRIBUTING](./CONTRIBUTING.md) about how to contribute to this project.
|
||||
|
||||
## Other Related Project Repositories
|
||||
|
||||
@ -93,8 +90,9 @@ Contributors are welcome to join Nacos project.
|
||||
* [Gitter](https://gitter.im/alibaba/nacos): Nacos's IM tool for community messaging, collaboration and discovery.
|
||||
* [Twitter](https://twitter.com/nacos2): Follow along for latest nacos news on Twitter.
|
||||
* [Weibo](https://weibo.com/u/6574374908): Follow along for latest nacos news on Weibo (Twitter of China version).
|
||||
* [User Mail Group](users-nacos@googlegroups.com): Nacos usage general discussion.
|
||||
* [Dev Mail Group](dev-nacos@googlegroups.com): Nacos developer discussion (APIs, feature design, etc).
|
||||
* [Commit Mail Group](commits-nacos@googlegroups.com): Commits notice, very high frequency.
|
||||
* [Nacos Segmentfault](https://segmentfault.com/t/nacos): Get latest notice and prompt help from Segmentfault.
|
||||
* Email Group:
|
||||
* users-nacos@googlegroups.com: Nacos usage general discussion.
|
||||
* dev-nacos@googlegroups.com: Nacos developer discussion (APIs, feature design, etc).
|
||||
* commits-nacos@googlegroups.com: Commits notice, very high frequency.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user