Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 3.4 KB

Contributor_Guidelines.md

File metadata and controls

51 lines (30 loc) · 3.4 KB

Contributing to Tarian Detector

Firstly, thank you for your interest and for considering contributing to Tarian Detector! It's people like you that make Tarian Detector such an incredible open-source project.

Here, we outline the standards for contributing to our project. Please ensure that you read and understand these guidelines before you start to work on the project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please read the full text so that you can understand what actions will and will not be tolerated.

Ways to Contribute

There are many ways you can directly contribute to the project:

  • Fixing bugs reported in the issue tracker.
  • Implementing new features or improvements.
  • Improving the project documentation.
  • Reporting valid issues in our issue tracker.

Reporting an Issue

Have you found an issue? Here are some guidelines to help you report it in a way that it can be resolved as quickly as possible:

  1. Search for existing issues. Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed. If a similar issue already exists, add a comment to that issue instead of opening a new one.

  2. Share as much information as possible. Include operating system and version, browser and version, version of Tarian Detector, and any debugging output. It all helps!

Pull Requests

  1. Fork the repository and create your branch from main.
  2. Update the README.md with details of changes. This includes new environment variables, exposed ports, useful file locations, and container parameters.
  3. Ensure your code adheres to our coding conventions. We utilize linters and other tools to maintain a consistent code style, so you must ensure your code complies with our established standards.
  4. Test your code. We value stable software and believe our users do too. Before you submit your Pull Request (PR), ensure you have tested your changes.
  5. Write meaningful commit messages. A good commit message helps reviewers understand what the pull request does, the scope of the work done, and aid in troubleshooting and understanding the code base history.
  6. Describe your changes. In your pull request, please describe what you changed and provide screenshots when possible. It helps maintainers, and the community understand the PR, its context, and the impact if it was to be merged.

Documentation

Documentation is a super important, critical part of this open-source project. Docs reside in the documentations directory in this repository. If you see a place where the documentation could be improved, please go ahead and do so! We will appreciate your help.

Thank You

Thank you for your time and for considering contributing to the Tarian Detector project! Every contribution helps, and we sincerely appreciate the time and effort you spent working on this project.

Security Disclosure

Security is very important to us. If you have any issue regarding security, please disclose the information responsibly by contacting our team by creating issue using our Security Form and not by creating a GitHub issue.

Acknowledgements

Your contributions to open-source, large or small, make great projects like this one possible. Thank you for taking the time to contribute.