Skip to content

Latest commit

 

History

History
158 lines (102 loc) · 5.19 KB

CONTRIBUTING.md

File metadata and controls

158 lines (102 loc) · 5.19 KB
Raw

Contributing to [Project Name]

Thank you for your interest in contributing to [Project Name]! Your contributions are crucial to the success of this project. Please follow these guidelines to ensure a smooth and efficient process.

Table of Contents

Reporting Bugs

If you find a bug or issue in the project, please follow these steps to report it:

  1. Check Existing Issues: Before reporting a new bug, check the issue tracker to see if the issue has already been reported.
  2. Provide a Detailed Description: Include a clear and concise description of the issue, steps to reproduce it, and the expected vs. actual behavior.
  3. Include Environment Details: Provide information about your environment (e.g., OS, Node.js version, etc.).
  4. Submit a Bug Report: Use the bug report template to submit your report.

Requesting Features

To request a new feature or enhancement:

  1. Search for Existing Requests: Check the issue tracker to ensure the feature hasn’t been requested before.
  2. Describe the Feature: Provide a detailed description of the feature and how it would benefit the project.
  3. Explain the Use Case: Describe how you or others might use this feature in practice.
  4. Submit a Feature Request: Use the feature request template to make your request.

Contributing Code

To contribute code to the project:

  1. Fork the Repository

    Create a personal fork of the repository on GitHub.

  2. Clone Your Fork

    Clone your fork to your local machine

    git clone <forked-repository-url>

  3. Configure Git on Local Dev Machine

    To configure Git to use commit message, issue, and pull request templates. Set up a global or local git config.

    • Locally: To use Git commit, issue, and pull request templates locally

      1. Configure Git Locally

        git config --local commit.template .github/COMMIT_TEMPLATE/commit_template.md
        git config --local core.quotepath false
        git config --local issue.template .github/ISSUE_TEMPLATE/bug_report_form.yml
        git config --local pullrequest.template .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

    • Globally: To use Git commit, issue, and pull request templates globally

      1. Copy the Templates: Copy the .github/ directory from this repository to C:\Program Files\Git\

      2. Configure Git Globally:

        git config --global commit.template C:/Program\ Files/Git/.github/COMMIT_TEMPLATE/commit_template.md
        git config --global core.quotepath false
        git config --global issue.template C:/Program\ Files/Git/.github/ISSUE_TEMPLATE/bug_report_form.yml
        git config --global pullrequest.template C:/Program\ Files/Git/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

  4. Create a New Branch

    Create a new branch for your changes.

    git checkout -b feature/your-feature

  5. Make Your Changes

    Implement your changes or new features.

  6. Write Tests

    Ensure that your code includes tests and passes existing tests.

  7. Commit Your Changes

    Follow the commit message guidelines.

    git add .
    git commit

  8. Push Your Changes

    Push your changes to your fork.

    git push origin feature/your-feature

  9. Open a Pull Request

    Open a pull request from your branch to the main branch of the original repository.

Code Review Process

All pull requests will undergo a code review process:

  1. Reviewers: The project maintainers will review your pull request.
  2. Feedback: Address any feedback or requested changes from the reviewers.
  3. Approval: Once approved, your pull request will be merged into the main branch.
  4. Merge: The project maintainers will handle merging.

Communication

Effective communication is key to successful collaboration:

  1. Use Issues for Discussions: Use the issue tracker for discussions about bugs, features, or questions.
  2. Be Respectful: Be respectful and constructive in all communications.
  3. Respond Promptly: Try to respond to comments or feedback in a timely manner.

Feedback and Suggestions

We welcome feedback and suggestions:

  1. Provide Constructive Feedback: Offer suggestions in a constructive and positive manner.
  2. Participate in Discussions: Engage in discussions to help improve the project.