Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 3.85 KB

CONTRIBUTING.md

File metadata and controls

67 lines (49 loc) · 3.85 KB

Contributing to The EV Finder

First off, thanks for taking the time to contribute! 👍 🎉

The following is a set of guidelines for contributing to the EV Finder. We want to make contributing to this project as easy and transparent as possible, whether it's:

Code of Conduct

This project and everyone participating in it is governed by The EV Finder Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Bugs are tracked as GitHub issues.

When creating a new issue, explain the problem and include additional details to help reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining the set of steps taken which reproduces the bug. Please don't forget to visit the EV Finder's debug page which will provide relevant information for your exact environment.
  • Explain which behavior you expected to see instead and why.
  • If able, please include a screenshot or video demonstrating the problem.

Proposing New Features

This section guides you through submitting a feature request for the EV Finder, including completely new features and minor improvements to existing functionality.

Before creating a feature request, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the feature request template, including the steps that you imagine you would take if the feature you're requesting existed.

Feature requests 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.
  • Provide specific examples to demonstrate the steps.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • If possible include annotated screenshots which help you demonstrate the steps or point out the part of the EV Finder which the suggestion is related to.
  • Explain why this enhancement would be useful to most EVFinder users.

Submitting a Fix

Pull Requests Are Welcome 🙏

Github Flow is used for the EV Finder, so all code changes happen through pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

This process has several goals:

  • Maintain the EV Finder's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible and most helpful EVFinder

Use a Consistent Coding Style

WIP

License

When you submit code changes, your submissions are understood to be under the same GNU GPLv3 license which covers this project.

References

This document took inspiration and was adapted from: