Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

44 lines (35 loc) · 1.6 KB
Raw

Contributing Guidelines

Thank you for looking into contributing to QFYAML! You are a valued member of the community, and we want you to feel empowered to contribute.

We use GitHub and ReadTheDocs

We use GitHub to host the QFYAML source code, to track issues, user questions, and feature requests, and to accept pull requests: https://github.com/yantosca/qfyaml. Please help out as you can in response to issues and user questions.

QFYAML documentation can be found at qfyaml.readthedocs.io.

How to submit changes

We use GitHub Flow, so all changes happen through pull requests. This workflow is described here: GitHub Flow.

As the author you are responsible for:

  • Testing your changes
  • Updating the user documentation (if applicable)
  • Supporting issues and questions related to your changes in the near-term

Coding conventions

The QFYAML codebase includes contributions from several authors. Therefore, some inconsistent conventions are inevitable, but we ask that you do your best to be consistent with nearby code.

How to request an enhancement

We accept feature requests through issues on GitHub. To request a new feature, open a new issue. Please include all the information that migth be relevant, including the motivation for the feature.

How to report a bug

Please see "Support Guidelines".

Where can I ask for help?

Please see "Support Guidelines".