Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 2.85 KB

Contributing to Sierra

👍🎉 First off, thanks for taking the time to contribute! 🎉👍


Table of contents


Links to Important Resources


How can I contribute?

Reporting a bug

This section guides you through submitting a bug report for Sierra. Following these guidelines helps maintainers and the community understand your report , reproduce the behavior, and find related reports.

Checked that your issue isn't already filed. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

How do I submit a (good) bug report?

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining what you want to do. When listing steps, don't just say what you did, but explain how you did it.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets (use Minimal Reproducible examples, if possible), which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Explain what output do you expected to see instead and why.
  • Provide extra information regarding the problem (if possible).

Requesting a feature

This section guides you through submitting a bug report for Sierra. Following these guidelines helps maintainers and the community understand your report , reproduce the behavior, and find related reports.

Before Submitting An Enhancement Suggestion

How Do I Submit A (Good) Enhancement Suggestion?