Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 3.33 KB
Raw

Contributing to Pletter

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

The following is a set of guidelines for contributing to Pletter and its packages, which are hosted on Github on GitHub. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to opensource@lykon.com.

We accept contributions via Pull Requests on Github.

How Can I Contribute?

Reporting Bugs

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

Before creating bug reports, please check if the bug was already reported before as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue on provide the following information.

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 how you started Pletter, e.g. which command exactly you used in the terminal. 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, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Include details about your configuration and environment:

  • Which version of Pletter are you using?
  • What's the name and version of the OS you're using?

Your First Code Contribution

Unsure where to begin contributing to Pletter? You can start by looking through these beginner and help-wanted issues:

  • [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
  • [Help wanted issues][help-wanted] - issues which should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Pull Requests

  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the Go styleguides.
  • Include thoughtfully-worded, well-structured tests.
  • Document new code
  • End files with a newline.

Happy Coding!