Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

86 lines (56 loc) · 3.23 KB
Raw

Welcome to Our Project!

First off, thank you for considering contributing to our project! We're really glad you're here, as we can always use help from the open-source community.

This document provides guidelines for people who want to contribute to our project. Feel free to propose changes to this document in a pull request.

How Can I Contribute?

Before contributing to this project, please make sure to read the README.md file and familiarize yourself with the commands listed in the package.json file.

Reporting Bugs

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

Please use the following format:

**Short Description:** [Summarize the problem]

**Steps to Reproduce:** [First Step, Second Step, etc.]

**Expected Behavior:** [What you expect to happen]

**Actual Behavior:** [What actually happens]

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for this project, including completely new features and minor improvements to existing functionality.

Please use the following format:

**Short Description:** [What would you like to see changed/added and why]

**Considered Alternatives:** [What other alternatives have you considered]

Your First Code Contribution

Unsure where to begin contributing to the project? You can start by looking through these Good First Issue and Help Wanted issues:

  • Good First 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 Good First Issues.

Pull Requests

The process described here has several goals:

  • Maintain the project's quality
  • Fix problems that are important to users
  • Enable a sustainable system for project maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests. The configured threshold must be respected.
  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!

Style Guide

Ensure the quality before opening your pull request. You will find all the necessary commands in the package.json file or you can run the git hooks manually to check your code.

Git Commit Messages

  1. Use the present tense ("Add feature" not "Added feature")
  2. Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  3. Limit the first line to 72 characters or less
  4. Reference issues and pull requests liberally after the first line
  5. The maintainers of this repository uses gitmoji. This is not mandatory.

Merging Policy

We require that all contributions show a linear history. This means no merge commits in your pull requests. Rebase your feature branch onto the main branch and resolve any conflicts. If you are unsure about how to do this, Atlassian has a great tutorial.