Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 2.18 KB

Contributing

Thank you for taking the time to contribute!

The following is a set of guidelines for contributing to Helvellyn, which is hosted at thombruce/helvellyn on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

  1. Code of Conduct
  2. Ground Rules
  3. Getting Started
  4. How to Report a Bug
  5. How to Suggest a Feature or Enhancement
  6. Code Review Process
  7. Community

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to thom@thombruce.com.

Ground Rules

  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Contributor Covenant Code of Conduct.

Getting Started

To make a code contribution:

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. Submit a pull request to have your changes considered for merging into the master branch

How to Report a Bug

Please submit an issue by completing the Bug Report Template.

How to Suggest a Feature or Enhancement

Please submit an issue by completing the Feature Request Template.

Code Review Process

Thom (that's me) will review your Pull Request. If it looks like a useful or necessary contribution, we'll discuss your code and progress towards getting it merged.

Features and bug fixes will be tested in a production environment before being merged.

Community

Feel free to join me for a chat on Discord.