Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

78 lines (56 loc) · 2.86 KB

Project Contribution Guidelines

Table of Contents

  1. Getting Started
  2. Finding an Issue
  3. Creating a Pull Request
  4. Coding Standards
  5. Testing
  6. Documentation
  7. Review Process
  8. Community Guidelines
  9. License

1. Getting Started

Before you begin contributing, make sure you have the following set up on your local machine:

  • Git installed
  • A GitHub account

2. Finding an Issue

  1. Visit our project's GitHub repository.
  2. Go to the "Issues" tab.
  3. Browse through the list of open issues.
  4. Filter issues based on your skills, interests, or availability.
  5. Comment on the issue you'd like to work on to express your interest or ask questions.
  6. To auto-assign an issue to yourself, reply with .take in the issue comment.

3. Creating a Pull Request

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make your changes and commit them with clear and concise commit messages.
  5. Push your changes to your forked repository.
  6. Create a pull request (PR) against the dev branch.

4. Coding Standards

  • Follow the coding style and standards used in the project.
  • Ensure your code is well-documented.
  • Use meaningful variable and function names.
  • Maintain consistency with existing code.

5. Testing

  • Test your code thoroughly to ensure it works as intended.
  • Write tests where applicable.
  • Ensure that all existing tests pass.
  • Include test cases that cover both normal and edge cases.

6. Documentation

  • Update or create documentation as necessary for your changes.
  • Keep documentation clear and concise.
  • If you make significant changes, update the project's README or documentation files.

7. Review Process

To update or create documentation, you need to have Markdown knowledge. Visit here to read about GitHub Markdown and here to practice.

  • Your PR will be reviewed by maintainers and contributors.
  • Be responsive to feedback and make necessary changes.
  • The PR may be merged once it receives approvals and passes automated tests.

8. Community Guidelines

  • Be respectful and considerate of other contributors.
  • Follow the project's code of conduct.
  • Encourage a positive and inclusive community environment.
  • Help others and answer questions when possible.

9. License

By contributing to this project, you agree that your contributions will be licensed under the project's open-source license. Make sure to review and understand the project's license before contributing.