Contributing Guidelines

March 28, 2023 · View on GitHub

Thank you for your interest in contributing to Torch Spatiotemporal!

We welcome contributions from everyone, and we appreciate your help to make this project better. Please take a moment to review this document in order to make the contribution process as smooth as possible.

🚀 Getting Started

Before you start contributing, please:

  1. Review the README.md file to get an understanding of the project and its goals.
  2. Make sure you have a GitHub account.
  3. Fork the repository on GitHub.
  4. Clone the forked repository locally on your machine.

🤝 How to Contribute

We welcome the following contributions:

🐛 Bug reports and fixes

If you find a bug or issue with the project, please submit a new issue with a clear description of the problem or error message, and include any relevant information such as screenshots, steps to reproduce the issue, and the version of the software you are using. If you are able to fix the issue, please create a pull request with the fix and include a reference to the issue number.

🚀 New features and enhancements

If you have an idea for a new feature or improvement to tsl, please submit a new issue with a clear description of the feature or improvement and why it would be valuable. If you are able to implement the feature or improvement, please create a pull request with the code changes and include a reference to the issue number.

🧪 Tests and test coverage improvements

We value good test coverage and welcome contributions to improve the existing tests or add new tests to cover more code paths. If you find a gap in test coverage or have an idea for a new test, please submit a new issue with a clear description of the test or coverage gap. If you are able to write the test, please create a pull request with the test changes and include a reference to the issue number.

🤝 Responding to Issues

We welcome community members to respond to issues and provide feedback to others. If you have experience with an issue or are able to help troubleshoot a problem, please comment on the issue with your thoughts or suggestions.

📝 Improving the Documentation

We welcome contributions to improve tsl documentation, including fixing typos, adding missing information, or improving the readability of the documentation. If you find an area of the documentation that needs improvement, please submit a new issue with a clear description of the problem or improvement. If you are able to improve the documentation, please create a pull request with the documentation changes and include a reference to the issue number.

🛠 Implementing Bug Fixes and Improvements

If you are able to implement a bug fix or improvement, please create a pull request with the code changes and include a reference to the issue number. Before submitting your pull request, please make sure that your code adheres to tsl's coding conventions and style guidelines and does not break any existing tests.

🤔 Code review and feedback

We welcome community members to review code changes and provide feedback to others. If you have experience with a particular area of the code or are able to provide feedback on a pull request, please leave a comment on the pull request with your thoughts or suggestions.

📜 Code of Conduct

Please note that by contributing to this project, you agree to abide by the Code of Conduct. Please be respectful and professional in all of your interactions with other contributors and tsl users. We value diversity and inclusion in our community and expect all contributors to follow these guidelines.

📝 Contribution Guidelines

When making a contribution to tsl, please keep the following guidelines in mind:

  1. Use clear and concise language in all communication and code changes.
  2. Follow the project's coding conventions and style guidelines.
  3. Test your code changes thoroughly and make sure they do not break any existing tests.
  4. When submitting a pull request, include a clear description of the changes and reference any related issues.
  5. Be open to feedback and willing to make changes to your code based on feedback from the community.

Conclusion

We appreciate your interest in contributing to Torch Spatiotemporal! By working together, we can make this project even better. If you have any questions or need help getting started with contributing, please don't hesitate to reach out to us. We look forward to your contributions!