Skip to content

Latest commit

 

History

History
executable file
·
100 lines (64 loc) · 5.81 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
100 lines (64 loc) · 5.81 KB
Raw

Contributing to EcoAssist

First off, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Cite the package in your literature
  • Post about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

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

I Have a Question

If you want to ask a question, we assume that you have read the readme, error-list, and frequently asked questions.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in that specific issue.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into. Which features did you execute, and in which order.

We will then take care of the issue as soon as possible.

I Want To Contribute

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please make sure that you are using the latest version before submitting a bug report.

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information in public. Instead sensitive bugs must be sent by email to contact@pvanlunteren.com.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps.
  • If the team is able to reproduce the issue, the issue will be left to be implemented by a contributor.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for EcoAssist, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.

Improving The Documentation

If you want to improve the documentation, please:

  • fork this repository
  • adjust the text accordingly
  • send a pull request

The maintainers will then review the changes and decide whether or not to merge.

Join The Project Team

If you don't see a way of contributing at the moment, but still want to join the project team for possible future contributions, send an email to contact@pvanlunteren.com. We'll take it from there.

Attribution

This guide is based on the contributing-gen. Make your own!