Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 2.33 KB
Raw

Contributing to Teredix

Thank you for considering contributing to teredix!

The following is a set of guidelines for contributing to teredix. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How to contribute

Reporting bugs

Before reporting a bug, please check if it has already been reported by searching through the project's [issues] (https://github.com/shaharia-lab/teredix/issues). If the issue has not been reported, you can create a new issue with the following information:

  • A clear and concise description of the bug
  • Steps to reproduce the behavior
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages (if applicable)
  • Environment (OS, browser, version, etc.)

Requesting features

If you have an idea for a feature, please check if it has already been requested by searching through the project's issues. If the feature has not been requested, you can create a new issue with the following information:

  • A clear and concise description of the feature
  • How the feature would be useful
  • Examples of how the feature could be implemented

Pull requests

We welcome pull requests from anyone who wants to contribute. To submit a pull request, please follow these steps:

  • Fork the repository and create a new branch
  • Make your changes and test them locally
  • Push your branch to your fork
  • Open a pull request and describe the changes you made

Please make sure your pull request adheres to the following guidelines:

  • Provide a clear and concise description of the problem and your solution
  • Make sure your code adheres to the project's style guide and passes tests
  • Explain the reasoning behind any changes you made
  • Make sure your branch is up-to-date with the latest changes in the main branch

Code of Conduct

This project and its community is governed by the Code of Conduct. Please review the Code of Conduct before contributing.

License

By contributing to this project, you agree that your contributions will be licensed under the [project's license] (https://github.com/shaharia-lab/teredix/blob/master/LICENSE).