Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 1.88 KB
Raw

Contributing to LatentScope

Thank you for considering contributing to LatentScope. Below are some guidelines to help you contribute effectively.

Code Style

Please adhere to the Python PEP-8 programming style guidelines when writing code. This will ensure consistency and readability across the codebase. You can find more details about PEP-8 here.

Writing Tests

It is important to write sufficient tests for any new code or changes to existing code. This helps in ensuring stability and reliability, preventing future regressions.

Reporting Bugs

If you encounter any issues or bugs, please report them on the github issues page of the project. When filing a bug, include as much detail as possible. Descriptions of the issue, steps to reproduce, and any relevant configurations or screenshots are very helpful.

Submitting Code

To submit your code to the project:

  • Fork the repository - Start by forking the project repository to your GitHub account.
  • Clone the repository - Clone the repository to your local machine to make your changes.
  • Create a new branch - It's best to create a branch for each set of changes you make.
  • Make your changes - Implement your feature or fix bugs, and make sure to write tests.
  • Run the tests - Ensure all tests pass and your changes do not break existing functionality.
  • Submit a Pull Request (PR) - Push your changes to your fork and then submit a pull request to the project's main branch. Provide a clear description of the changes and any other information that might be useful.

Contacting the Authors

If you have questions or concerns about the algorithms, feel free to contact the authors. The authors' email addresses can be found in the LatentScope paper.

We appreciate your contributions to improving this project. Happy coding!