Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (38 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

54 lines (38 loc) · 2.63 KB
Raw

Contributing to tadkit-core

We’re thrilled that you want to contribute to our project! Your contributions help make the project better for everyone. Please take a moment to review this document in order to make your contribution as smooth as possible.

Table of Contents

  1. How Can I Contribute?
  2. Reporting Bugs
  3. Suggesting Enhancements
  4. Code Contributions
  5. Style Guide
  6. Submission

How Can I Contribute?

There are many ways to contribute to this project. Here are a few options:

  • Reporting bugs: If you find any bugs in the project, please report them.
  • Suggesting new features: If you have an idea for improving the project, feel free to suggest it.
  • Writing code: If you’re comfortable with the codebase, feel free to submit fixes or new features.
  • Improving documentation: You can improve documentation, tutorials, or any relevant project text.

Reporting Bugs

When reporting bugs, please be as detailed as possible so we can help resolve the issue faster. A good bug report includes:

  • Description of the problem: What are you trying to do? What is happening instead?
  • Steps to reproduce: Please include a list of steps we can follow to reproduce the issue.
  • Expected behavior: What should have happened?
  • Screenshots or logs: Attach any relevant screenshots or logs that can help in identifying the issue.

Please use the issue tracker to report bugs.

Suggesting Enhancements

We love suggestions that help improve the project! If you have an idea for a new feature or improvement, feel free to open an issue with the following information:

  • What problem does it solve?
  • What is the proposed solution?
  • Why do you think this enhancement is valuable?

Code Contributions

To contribute code, please follow these steps:

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/your-feature

Submission

To submit your code, please make a pull request to our main branch. For those just getting started, Github has a how to about pull requests.

You will be asked to sign our CLA (Contributing License Agreement) before we can merge your code. Please read it before you start working on the project.

The project team members will then be assigned to review your pull request. Once the pull request is approved, your changes will be merged.