Skip to content

Latest commit

 

History

History
27 lines (14 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

27 lines (14 loc) · 1.49 KB
Raw

  1. Fork the repository: Fork the repository to your own GitHub account and clone it to your local machine.

  2. Create a new branch: Create a new branch with a descriptive name for the feature or bug fix you are working on.

  3. Make changes: Make changes to the codebase and ensure that your changes pass the linting checks.

  4. Commit changes: Commit your changes with a descriptive commit message that explains what changes you made.

  5. Push changes: Push your changes to your forked repository.

  6. Create a pull request: Create a pull request from your forked repository to the original repository.

  7. Wait for review: Wait for the maintainers of the repository to review your pull request. They may ask you to make changes or provide additional information.

  8. Merge changes: Once your pull request has been approved, the maintainers will merge your changes into the main branch of the repository.

To ensure that your contributions are accepted, please follow these guidelines:

  • Linting checks: Ensure that your code passes the linting checks before submitting a pull request.

  • Descriptive commit messages: Use descriptive commit messages that explain what changes you made.

  • One feature per pull request: Submit one feature or bug fix per pull request.

  • Documentation: If you are adding new features or changing existing ones, please update the documentation accordingly.

  • Be respectful: Be respectful to other contributors and maintainers of the repository.