Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.46 KB

Contributing Guidelines

Thank you for your interest in contributing to our project! We welcome contributions from the community and appreciate your help in making our project better.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix.

Making Changes

  1. Ensure you're working on the latest version of the project.
  2. Make your changes in your feature branch.
  3. Follow the coding style and conventions used in the project.
  4. Write clear, concise commit messages.

Testing

  1. Run existing tests to ensure your changes don't break any functionality.
  2. Write new tests for your feature or bug fix if applicable.
  3. Ensure all tests pass before submitting your changes.

Submitting Changes

  1. Push your changes to your fork on GitHub.
  2. Create a pull request from your fork to the main repository.
  3. Clearly describe your changes and their purpose in the pull request description.
  4. Link any relevant issues in the pull request description.

Code Review

  1. Wait for maintainers to review your pull request.
  2. Be open to feedback and make necessary changes if requested.
  3. Respond promptly to any questions or comments on your pull request.

Additional Guidelines

  • Follow the project's code of conduct.
  • Keep discussions respectful and constructive.
  • If you're unsure about anything, don't hesitate to ask for help.

Thank you for contributing to our project!