Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 2.78 KB

Contributing to chicle

First off, thank you for considering contributing to chicle!

Code of Conduct

By participating in this project, you are expected to remain civil.

How Can I Contribute?

Reporting Bugs

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

  • 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.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for chicle, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps or point out the part of chicle which the suggestion is related to.
  • Explain why this enhancement would be useful to most chicle users.

Your First Code Contribution

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

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

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the Go Code Review Comments
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Go Styleguide

All Go code is linted with golangci-lint.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues for bugs in the code
  • enhancement - Issues for new features or improvements
  • documentation - Issues related to documentation
  • good first issue - Good for newcomers

Getting Help

If you need help, you can ask questions on our issues page.

Thank you for contributing to chicle!