Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 4.67 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 4.67 KB
Raw

Contributing to Rosetta-Specifications

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.

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.
    • Describe the bug - A clear and concise description of what the bug is.
    • To Reproduce - Steps to reproduce the behavior.
    • Expected behavior - A clear and concise description of what you expected to happen.
    • Additional context - You can include any relevant stack traces or debugging output in this section.
  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.
    • Is your feature request related to a problem? Please describe. - Describe what the problem is. For example, “I'm always frustrated when [...]”.
    • Describe the solution you'd like - Describe what you want to happen.
    • Describe alternatives you've considered - Describe any alternative solutions or features you've considered.
    • Additional context - You can add any other context or screenshots about the feature request in this section.
  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 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.

  • Add tests for your feature. You should be able to look at other tests for examples. If you're unsure, don't hesitate to open an issue and ask!

  • Submit your pull request!

To submit your pull request, follow these steps:

  1. 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.

Support Requests

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.

All support requests must be made via our support team.