Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 3.22 KB
Raw

zon Contribution Guidelines

This document contains the contribution guidelines for the zon project. All contributions will be welcome, but they should follow the guidelines described in this document.

Table of Contents

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

Issues

Issues should be used to report bugs, request features, or discuss changes in existing features. When creating an issue, please follow the guidelines below:

  • Bug reports should include a short summary of the bug, a description of the expected behavior, and a description of the actual behavior. If possible, please include a minimal code sample that reproduces the bug.
  • Feature requests should include a short summary of the feature, a description of the motivation behind the feature, and a description of the proposed implementation.
  • Changes in existing features should include a short summary of the change, a description of the motivation behind the change, and a description of the proposed implementation.
  • Questions should include a short summary of the question, a description of the context in which the question arose, and a description of the desired outcome.
  • General discussions should include a short summary of the topic, a description of the context in which the topic arose, and a description of the desired outcome.
  • Other issues should include a short summary of the issue, a description of the context in which the issue arose, and a description of the desired outcome.
  • All issues should be tagged with the appropriate labels. If you are unsure about which labels to use, please use the help wanted label.

Pull Requests

Pull requests should be used to propose changes to the codebase. When creating a pull request, please follow the guidelines below:

  • Bug fixes should include a short summary of the bug, a description of the expected behavior, and a description of the actual behavior. If possible, please include a minimal code sample that reproduces the bug.
  • New features should include a short summary of the feature, a description of the motivation behind the feature, and a description of the proposed implementation.
  • Changes in existing features should include a short summary of the change, a description of the motivation behind the change, and a description of the proposed implementation.
  • All pull requests should be tagged with the appropriate labels. If you are unsure about which labels to use, please use the help wanted label.
  • All pull requests should (but are not strictly required to) be accompanied by a description of the alternatives considered when making the changes in the pull request.

All changes must be summarized in CHANGELOG.md.

Furthermore, new contributors can add themselves to the list of contributors, present at CONTRIBUTORS.