Skip to content

Commit e16e590

Browse files
committed
Add README.md and fundamental documents
Signed-off-by: Eric Zhao <[email protected]>
1 parent f263e4a commit e16e590

File tree

4 files changed

+178
-0
lines changed

4 files changed

+178
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- Thanks for submitting a pull request! Here are some tips for you:
2+
1. Please make sure you have read and understood the contributing guidelines: https://github.com/sentinel-group/blob/master/CONTRIBUTING.md
3+
2. Please make sure the PR has a corresponding issue.
4+
-->
5+
6+
### Describe what this PR does / why we need it
7+
8+
9+
### Does this pull request fix one issue?
10+
11+
<!--If that, add "Fixes #xxxx" below in the next line. For example, Fixes #15. Otherwise, add "NONE" -->
12+
13+
### Describe how you did it
14+
15+
16+
### Describe how to verify it
17+
18+
19+
### Special notes for reviews

CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
72+
73+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing to Sentinel
2+
3+
Welcome to Sentinel! This document is a guideline about how to contribute to Sentinel Golang.
4+
If you find something incorrect or missing, please leave comments / suggestions.
5+
6+
## Before you get started
7+
8+
### Code of Conduct
9+
10+
Please make sure to read and observe our [Code of Conduct](./CODE_OF_CONDUCT.md).
11+
12+
### Setting up your development environment
13+
14+
You should have Go 1.12+ installed in your operating system.
15+
16+
## Contributing
17+
18+
We are always very happy to have contributions, whether for typo fix, bug fix or big new features.
19+
Please do not ever hesitate to ask a question or send a pull request.
20+
21+
We strongly value documentation and integration with other projects.
22+
We are very glad to accept improvements for these aspects.
23+
24+
### GitHub workflow
25+
26+
We use the `master` branch as the development branch, which indicates that this is a unstable branch.
27+
28+
Here are the workflow for contributors:
29+
30+
1. Fork to your own
31+
2. Clone fork to local repository
32+
3. Create a new branch and work on it
33+
4. Keep your branch in sync
34+
5. Commit your changes (make sure your commit message concise)
35+
6. Push your commits to your forked repository
36+
7. Create a pull request
37+
38+
Please follow [the pull request template](./.github/PULL_REQUEST_TEMPLATE.md).
39+
Please make sure the PR has a corresponding issue.
40+
41+
After creating a PR, one or more reviewers will be assigned to the pull request.
42+
The reviewers will review the code.
43+
44+
Before merging a PR, squash any fix review feedback, typo, merged, and rebased sorts of commits.
45+
The final commit message should be clear and concise.
46+
47+
### Open an issue / PR
48+
49+
We use [GitHub Issues](https://github.com/sentinel-group/sentinel-golang/issues) and [Pull Requests](https://github.com/sentinel-group/sentinel-golang/pulls) for trackers.
50+
51+
If you find a typo in document, find a bug in code, or want new features, or want to give suggestions,
52+
you can [open an issue on GitHub](https://github.com/sentinel-group/sentinel-golang/issues/new) to report it.
53+
Please follow the guideline message in the issue template.
54+
55+
If you want to contribute, please follow the [contribution workflow](#github-workflow) and create a new pull request.
56+
If your PR contains large changes, e.g. component refactor or new components, please write detailed documents
57+
about its design and usage.
58+
59+
Note that a single pull request should not be too large. If heavy changes are required, it's better to separate the changes
60+
to a few individual PRs.
61+
62+
### Code review
63+
64+
All code should be well reviewed by one or more committers. Some principles:
65+
66+
- Readability: Important code should be well-documented. Comply with our code style.
67+
- Elegance: New functions, classes or components should be well designed.
68+
- Testability: Important code should be well-tested (high unit test coverage).
69+
70+
## Community
71+
72+
### Contact us
73+
74+
#### Gitter
75+
76+
Our Gitter room: [https://gitter.im/alibaba/Sentinel](https://gitter.im/alibaba/Sentinel).

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<img src="https://user-images.githubusercontent.com/9434884/43697219-3cb4ef3a-9975-11e8-9a9c-73f4f537442d.png" alt="Sentinel Logo" width="50%">
2+
3+
# Sentinel: The Sentinel of Your Microservices
4+
5+
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
6+
[![Gitter](https://badges.gitter.im/alibaba/Sentinel.svg)](https://gitter.im/alibaba/Sentinel)
7+
8+
## Contributing
9+
10+
Contributions are always welcomed! Please see [CONTRIBUTING](./CONTRIBUTING.md) for detailed guidelines.

0 commit comments

Comments
 (0)