Skip to content
This repository was archived by the owner on Apr 9, 2024. It is now read-only.

Commit f85f831

Browse files
author
Eason Gao
authored
refactor(arch): split rpc module to core types and utility (#301)
* refactor: build rpc types crate * refactor: peel ckb client * refactor: error handle * remove old rpc * refactor * refactor: remove extension module * add extension templete * remove db protocol * change extension templete * recover rpc tests * change templete name * fix CI * add docs * rebase dev * cargo update * update doc * change crates version * update readme * add how to contribute * rebase dev
1 parent 462f00d commit f85f831

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1349
-1732
lines changed

CONTRIBUTING.md

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Contributing
2+
3+
Our goal is to make contributing to the `mercury` project easy and transparent.
4+
5+
When contributing to this repository, please first discuss the change you wish to make via issue, or any other method with the community before making a change.
6+
7+
### Report Issue
8+
9+
* Read known issues to see whether the issue is already addressed there.
10+
11+
* Search existing issues to see whether others had already posted a similar issue.
12+
13+
* **Do not open up a GitHub issue to report security vulnerabilities**. Instead,
14+
refer to the [security policy](SECURITY.md).
15+
16+
* When creating a new issue, be sure to include a title and clear description. It is appreciated that if you can also attach as much relevant information as possible, such as version, environment, reproducing steps, samples.
17+
18+
### Send PR
19+
20+
* See [Code Standards](https://rust-coding-guidelines.github.io/rust-coding-guidelines-zh/safe-guides/intro.html) for code guidelines.
21+
22+
* See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
23+
24+
1. Fork the `mercury` repo and create your branch from master.
25+
2. If you have added code that should be tested, add unit tests.
26+
3. Verify and ensure that the test suite passes.
27+
4. Run `make ci` to lint and test the code before commit.
28+
5. Make sure your code passes CI.
29+
6. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
30+
7. Submit your pull request.
31+
32+
## Code of Conduct
33+
34+
### Our Pledge
35+
36+
In the interest of fostering an open and welcoming environment, we as
37+
contributors and maintainers pledge to making participation in our project and
38+
our community a harassment-free experience for everyone, regardless of age, body
39+
size, disability, ethnicity, sex characteristics, gender identity and expression,
40+
level of experience, education, socio-economic status, nationality, personal
41+
appearance, race, religion, or sexual identity and orientation.
42+
43+
### Our Standards
44+
45+
Examples of behavior that contributes to creating a positive environment
46+
47+
include:
48+
49+
* Using welcoming and inclusive language
50+
* Being respectful of differing viewpoints and experiences
51+
* Gracefully accepting constructive criticism
52+
* Focusing on what is best for the community
53+
* Showing empathy towards other community members
54+
55+
Examples of unacceptable behavior by participants include:
56+
57+
* The use of sexualized language or imagery and unwelcome sexual attention or
58+
advances
59+
* Trolling, insulting/derogatory comments, and personal or political attacks
60+
* Public or private harassment
61+
* Publishing others' private information, such as a physical or electronic
62+
address, without explicit permission
63+
* Other conduct which could reasonably be considered inappropriate in a
64+
professional setting
65+
66+
### Our Responsibilities
67+
68+
Project maintainers are responsible for clarifying the standards of acceptable
69+
behavior and are expected to take appropriate and fair corrective action in
70+
response to any instances of unacceptable behavior.
71+
72+
Project maintainers have the right and responsibility to remove, edit, or
73+
reject comments, commits, code, wiki edits, issues, and other contributions
74+
that are not aligned to this Code of Conduct, or to ban temporarily or
75+
permanently any contributor for other behaviors that they deem inappropriate,
76+
threatening, offensive, or harmful.
77+
78+
### Scope
79+
80+
This Code of Conduct applies both within project spaces and in public spaces
81+
when an individual is representing the project or its community. Examples of
82+
representing a project or community include using an official project e-mail
83+
address, posting via an official social media account, or acting as an appointed
84+
representative at an online or offline event. Representation of a project may be
85+
further defined and clarified by project maintainers.
86+
87+
### Enforcement
88+
89+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
90+
reported by contacting the project team at [email protected]. All
91+
complaints will be reviewed and investigated and will result in a response that
92+
is deemed necessary and appropriate to the circumstances. The project team is
93+
obligated to maintain confidentiality with regard to the reporter of an incident.
94+
Further details of specific enforcement policies may be posted separately.
95+
96+
Project maintainers who do not follow or enforce the Code of Conduct in good
97+
faith may face temporary or permanent repercussions as determined by other
98+
members of the project's leadership.
99+
100+
### Attribution
101+
102+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
103+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
104+
105+
[homepage]: https://www.contributor-covenant.org
106+
107+
For answers to common questions about this code of conduct, see
108+
https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)