Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 2.84 KB
Raw

Contributing to turnity

Thank you for considering contributing to turnity!
We appreciate your input and want to make the contribution process as easy and transparent as possible. Whether you want to report a bug, discuss code improvements, submit a fix, propose new features, or become a maintainer, we welcome your involvement.

Reporting Bugs

If you encounter any bugs or issues, please use GitHub's issue tracking system. You can report a bug by opening a new issue. When submitting a bug report, please provide detailed information, including the steps to reproduce the issue, relevant background information, and sample code if possible.

Development on GitHub

We use GitHub to host our code, track issues and feature requests, and accept pull requests. We follow the GitHub Flow for making code changes. This means that all code modifications should be proposed through pull requests. Pull requests provide a structured and collaborative way to review and discuss code changes.

If you'd like to contribute, please follow these steps:

  1. Select an open issue to work on or create a new issue if none exists.
    • Assign the issue to yourself and set its status to "in progress."
  2. Fork the repository and create a branch from the main branch.
    • Use the issue number as the branch name, e.g., GE-111.
  3. If you have made changes to the code that should be tested, please include appropriate tests.
  4. If you have modified any APIs, ensure that the new documentation changes are included in the pull request comment.
  5. Create a pull request and provide information in the "Why" and "What" sections:
    • Link the pull request to the corresponding issue.
    • Assign the pull request to yourself.
    • Make sure each pull request is associated with only one issue.
    • If the pull request is still in progress, mark it as a draft.
    • Ensure your code follows the Coding Style conventions
  6. Submit the pull request!

License

By contributing to this project, you agree that your contributions will be licensed under the same MIT License that covers the project. If you have any concerns, please reach out to the maintainers.

Coding Style

To maintain code consistency, please adhere to the following coding style guides: