Skip to content

Latest commit

 

History

History
39 lines (21 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

39 lines (21 loc) · 1.86 KB
Raw

Contributing to Poutine

Thank you for your interest in contributing to poutine! We value the contributions of our community members and look forward to your input.

Code of Conduct

Before you start contributing, please make sure to read and abide by our Code of Conduct. Additionally, we follow the Linux Foundation's guidelines for commit sign-offs. Please sign off your commits using the -s or --signoff flag.

Getting Started

Environment Setup

To contribute to Poutine, you'll need the following:

Contributing Process

  1. Find an Issue or Feature: Check our Roadmap or open GitHub Issues. Pick an existing issue or propose your feature request there.

  2. Get Approval: For new features, wait for the issue to be labeled Approved by the maintainers.

  3. Fork and Code: Fork the repository, make your changes, and ensure your code adheres to the provided coding conventions and quality standards.

  4. Submit a Pull Request (PR): Once you've completed your changes, submit a PR. Make sure your PR title and description clearly describe the changes. Include the issue number your PR addresses.

Testing and Linting

  • Run gofmt to ensure your code is properly formatted.
  • Include any tests relevant to the bug or feature you are addressing.

Documentation

  • Update the README.md if you introduce or modify any commands.
  • If your changes involve adding or altering rules, update the corresponding markdown file in docs/content/en/rules/[RULE_ID].md.

Community and Questions

Currently, we handle all communications through GitHub issues and pull requests. If you have questions or need help with the setup, please open an issue and tag it as a question.