Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (55 loc) · 4.54 KB

CONTRIBUTING.md

File metadata and controls

88 lines (55 loc) · 4.54 KB

Contributing to Price Scout

First off, thank you for considering contributing to Price Scout! It's people like you that make Price Scout such a great tool.

Code of Conduct

This project and everyone participating in it is governed by the Price Scout Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Price Scout. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related bugs.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template.

Before Submitting A Bug Report

  • Check the FAQs and Documentation for a list of common questions and how to resolve them.
  • Check the issues to see if the problem has already been reported.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Explain the problem and include additional details to help maintainers 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.
  • Describe the behavior you observed after following the steps and explain precisely what is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or the at-fault behavior.

Suggesting Enhancements

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

Before creating enhancement suggestions, 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 out the required template.

Before Submitting An Enhancement Suggestion

  • Check the FAQs and Documentation for a list of common questions and how to resolve them.
  • Check the issues 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.

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.
  • Explain why this enhancement would be useful to most Price Scout users.

Your First Code Contribution

Pull Requests

The process which describes how to submit your code contribution:

  1. Fork the repo and create your branch from master.
  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!

Pull Request Guidelines

  • The pull request description should clearly state what it does and why.
  • Each pull request should ideally focus on a single piece of functionality.
  • If your pull request is work in progress (WIP), please open it as a "Draft Pull Request".
  • Be responsive to reviews.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Java Coding Style

  • We use standard Java coding conventions.
  • Meaningful variable and method names.
  • Comments for non-trivial logic.

Thank you for being part of the Avengers team! 🚀