Skip to content

Latest commit

 

History

History
80 lines (48 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

80 lines (48 loc) · 4.23 KB

Contributing to rosetta-bitcoin

Code of Conduct

All interactions with this project follow our Code of Conduct. By participating, you are expected to honor this code. Violators can be banned from further participation in this project, or potentially all Coinbase projects.

How to Contribute

You can contribute to this repository by asking questions, providing feedback, and reporting issues.

Asking Questions

Submit your questions via the Rosetta Community boards.

Providing Feedback

You can also use the Rosetta Community boards to provide feedback.

Reporting Issues

You can report issues by submitting bug reports, feature requests, or pull requests via GitHub. You must submit security issues and support requests through the links provided.

Bug Reports

Before filing a bug report, ensure that your issue has not already been reported. It may already be fixed!

If your bug hasn’t been fixed, follow these steps to file a bug report:

  1. Open an issue in GitHub.
  2. Add a title for your bug report. It should briefly describe the problem.
  3. Follow the template that appears in the Write text box. This is the best way to describe the bug.
  4. Click Submit new issue to finish filing the bug report.

Feature Requests

We welcome feedback with or without pull requests. If you have an idea for how to improve the project, great! All we ask is that you take the time to write a clear and concise explanation of the need you are trying to solve. If you have thoughts on how it can be solved, include those too!

To submit a feature request, follow these steps:

  1. Open an issue in GitHub.
  2. Add a title for your feature request. It should briefly describe your requested feature.
  3. Follow the template that appears in the Write text box. This is the best way to explain your request. Be clear and concise in your responses.
  4. Click Submit new issue to submit the feature request.

The best way to see a feature added, however, is to submit a pull request.

Pull Requests

Before creating your pull request, it's usually worth asking whether the code you're planning on writing will be considered for merging. You can do this by opening an issue and asking. It may also help give the maintainers context for when the time comes to review your code.

Ensure that your commit messages are well-written. This can double as your pull request message, so it pays to take the time to write a clear message.

Additionally, make sure that you have written unit tests for your changes. If you're unsure as to what to test, don't hesitate to open an issue and ask!

To submit your pull request, follow these steps:

  1. Follow these instructions on how to open a pull request in GitHub.
  2. Click Create pull request to submit your pull request.

Once you submit your pull request, a reviewer will revise it, and either approve it or offer suggestions.

Security Issues

You can send a report through Coinbase's H1 program. Check out the Security tab for more information.

Support Requests

All support requests must be made via our support team.

For security reasons, any communication referencing support tickets for Coinbase products will be ignored. The request will have its content redacted and will be locked to prevent further discussion.