Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 2.3 KB
Raw

Contributing Guidelines

Code of Conduct

This project is intended to be a safe, welcoming space for collaboration. All contributors are expected to adhere to the Contributor Covenant code of conduct. Thank you for being kind to each other!

Contributions welcome!

Before spending lots of time on something, ask for feedback on your idea first!

Please search issues and pull requests before adding something new! This helps avoid duplicating efforts and conversations.

This project welcomes any kind of contribution! Here are a few suggestions:

  • Ideas: participate in an issue thread or start your own to have your voice heard.
  • Writing: contribute your expertise in an area by helping expand the included content.
  • Copy editing: fix typos, clarify language, and generally improve the quality of the content.
  • Formatting: help keep content easy to read with consistent formatting.
  • Code: help maintain and improve the project codebase.

Code Style

This repository uses gofmt to maintain code style and consistency, and to avoid style arguments.

Project Governance

This is an OPEN Open Source Project.

Individuals making significant and valuable contributions are given commit access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

Rules

There are a few basic ground rules for collaborators:

  1. No --force pushes or modifying the Git history in any way.
  2. Non-master branches ought to be used for ongoing work.
  3. External API changes and significant modifications ought to be subject to an internal pull request to solicit feedback from other contributors.
  4. Internal pull requests to solicit feedback are encouraged for any other non-trivial contribution but left to the discretion of the contributor.
  5. Contributors should attempt to adhere to the prevailing code style.

Releases

Declaring formal releases remains the prerogative of the project maintainer.

Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull requests or changes by contributors where you believe you have something valuable to add or change.