Skip to content

Commit 90a45bf

Browse files
authored
CONTRIBUTING: Add contribution guidelines (#11)
1 parent 45821a8 commit 90a45bf

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to Base Node
2+
3+
## Code of Conduct
4+
5+
All interactions with this project follow our [Code of Conduct][code-of-conduct].
6+
By participating, you are expected to honor this code. Violators can be banned
7+
from further participation in this project, or potentially all Base and/or
8+
Coinbase
9+
projects.
10+
11+
[code-of-conduct]: https://github.com/coinbase/code-of-conduct
12+
13+
## Bug Reports
14+
15+
* Ensure your issue [has not already been reported][1]. It may already be fixed!
16+
* Include the steps you carried out to produce the problem.
17+
* Include the behavior you observed along with the behavior you expected, and
18+
why you expected it.
19+
* Include any relevant stack traces or debugging output.
20+
21+
## Feature Requests
22+
23+
We welcome feedback with or without pull requests. If you have an idea for how
24+
to improve the project, great! All we ask is that you take the time to write a
25+
clear and concise explanation of what need you are trying to solve. If you have
26+
thoughts on _how_ it can be solved, include those too!
27+
28+
The best way to see a feature added, however, is to submit a pull request.
29+
30+
## Pull Requests
31+
32+
* Before creating your pull request, it's usually worth asking if the code
33+
you're planning on writing will actually be considered for merging. You can
34+
do this by [opening an issue][1] and asking. It may also help give the
35+
maintainers context for when the time comes to review your code.
36+
37+
* Ensure your [commit messages are well-written][2]. This can double as your
38+
pull request message, so it pays to take the time to write a clear message.
39+
40+
* Add tests for your feature. You should be able to look at other tests for
41+
examples. If you're unsure, don't hesitate to [open an issue][1] and ask!
42+
43+
* Submit your pull request!
44+
45+
## Support Requests
46+
47+
For security reasons, any communication referencing support tickets for Coinbase
48+
products will be ignored. The request will have its content redacted and will
49+
be locked to prevent further discussion.
50+
51+
All support requests must be made via [our support team][3].
52+
53+
[1]: https://github.com/base-org/node/issues
54+
[2]: https://medium.com/brigade-engineering/the-secrets-to-great-commit-messages-106fc0a92a25
55+
[3]: https://support.coinbase.com/customer/en/portal/articles/2288496-how-can-i-contact-coinbase-support-
56+

0 commit comments

Comments
 (0)