Welcome to the obvs library! We appreciate your interest in contributing to the project. This document provides guidelines and information to help you contribute effectively.
- Welcome Note
- Links to Resources
- How To Contribute
- Coding Conventions and Style Guide
- Code of Conduct
- Acknowledgements
- Project Owner and Contributors Information
- Where to Get Help
Thank you for considering contributing to the obvs library! Your contributions, whether they are bug reports, feature suggestions, or code improvements, are greatly appreciated. By contributing, you help make obvs a better tool for analyzing and interpreting language models.
Please place your tests in the tests/ directory and ensure they follow the naming convention test_*.py.
To submit your changes, please follow the steps outlined in the How To Contribute section.
To set up the development environment for obvs, please refer to the Development Setup section in the README.
If you encounter a bug while using obvs, please open an issue on the GitHub repository. Provide a clear and descriptive title, along with a detailed description of the problem, steps to reproduce it, and any relevant code snippets or error messages.
If you would like to fix a bug, follow these steps:
- Check the issue tracker to see if the bug has already been reported. If not, open a new issue describing the bug.
- Fork the repository and create a new branch for your bug fix.
- Make the necessary changes to fix the bug.
- Write tests to verify the bug fix and ensure it doesn't introduce new issues.
- Commit your changes and push them to your forked repository.
- Submit a pull request to the main repository, referencing the related issue.
If you have an idea for an enhancement or a new feature for obvs, please open an issue on the GitHub repository. Provide a clear and descriptive title, along with a detailed description of the enhancement, its benefits, and any relevant examples or use cases.
When contributing code to obvs, please adhere to the following coding conventions and style guide:
- Use meaningful variable and function names.
- Follow the PEP 8 style guide for Python code.
- Write docstrings for functions and classes following the NumPy docstring format.
- Use type hints to improve code readability and maintainability.
- Keep lines of code under 80 characters in length.
Please note that the obvs project follows a CODE_OF_CONDUCT. By participating in this project, you are expected to uphold this code. Please report any unacceptable behavior to the project maintainers.
We would like to express our gratitude to all the contributors who have helped improve the obvs library. Your contributions are greatly appreciated!
If you have any questions or need assistance with contributing to obvs, please open an issue on the GitHub repository. You can also reach out to the project maintainers or join our github discussions for further help and discussion.