Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

81 lines (54 loc) · 2.92 KB

Contributing to [Project Title]

We are thrilled that you're interested in contributing to our project! By participating, you agree to abide by our Code of Conduct.

Table of Contents

Getting Started

Before you start, please check out the issues with the good first issue or help wanted labels. They are a great way to get familiar with our codebase and contribution process.

Development Setup

To get started, please make sure you have [list of dependencies, e.g., Node.js, Python, etc.] installed.

  1. Fork the repository.
  2. Clone your fork to your local machine: git clone https://github.com/your-username/your-project.git
  3. Navigate to the project directory: cd your-project
  4. Install dependencies: npm install or pip install -r requirements.txt

Reporting Bugs

If you find a bug, please help us by reporting it. Before you do, follow these steps:

  • Check existing issues to see if the bug has already been reported.
  • Create a new issue and include:
    • A clear and descriptive title.
    • A detailed description of the bug.
    • Steps to reproduce the issue.
    • Your environment details (OS, software versions, etc.).

Suggesting Enhancements

If you have an idea for a new feature or improvement, please let us know by submitting an enhancement suggestion.

  • Check existing issues to see if the enhancement has already been proposed.
  • Create a new issue with a clear title and a description of your proposed feature.

Submitting a Pull Request

Follow these steps to submit a pull request for your changes:

  1. Create a new branch with a descriptive name, like feature/your-feature-name or bugfix/issue-number.
  2. Make your changes. Adhere to the project's style guide.
  3. Run tests to ensure your changes haven't introduced any regressions: npm test
  4. Commit your changes with a clear and concise message. We follow the Conventional Commits standard.
  5. Push your changes to your forked repository.
  6. Create a pull request to the main branch of the original repository. Please fill out the provided pull request template.

Contribution Hall of Fame

We would like to extend our gratitude to everyone who has contributed to this project:

  • [Contributor Name 1]
  • [Contributor Name 2]

Getting Help

If you have a question or need help with your contribution, feel free to:

  • Comment on an issue.
  • Join our community chat: [link-to-your-discord-or-slack].