Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (37 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 2.58 KB
Raw

Contributing to Quotation Factory

First off, thank you for considering contributing to Quotation Factory! We appreciate all the help we can get, whether it's fixing bugs, adding new features, or improving documentation.

Code of Conduct

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

What Should I Know Before I Get Started?

Project Setup

If you're not sure where to start, here are a few quick tips:

  • Fork the repository and clone it locally. Connect your local to the original 'upstream' repo by adding it as a remote.
  • Install the dependencies required to run the project.
  • Ensure the project runs correctly on your local machine.

Our Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Bug Reports

Bugs are tracked as GitHub issues. When reporting a bug, include as many details as possible:

  • Use a clear and descriptive title.
  • Describe the exact steps which reproduce the problem.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and point out what exactly is the issue with that behavior.
  • Explain which behavior you expected to see instead and why.

Feature Requests

Feature requests are welcome. But take a moment to 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. Provide as much detail and context as possible.

Your First Contribution

Unsure where to begin contributing to Quotation Factory? You can start by looking through 'beginner' and 'help-wanted' issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

The process described here has several goals:

  • Maintain Quotation Factory's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Quotation Factory

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide and coding conventions of the project.
  • Write tests.
  • Write a good commit message.

Any Questions?

Don't hesitate to ask! Open an issue on GitHub.

Thank you for contributing to Quotation Factory!