Thank you for considering contributing to this project! Here's how you can help:
- Reporting Bugs: Open an issue describing the bug, steps to reproduce, and expected behavior
- Suggesting Features: Open an issue describing the feature and its potential benefits
- Improving Documentation: Help make the documentation clearer and more comprehensive
- Adding Templates: Contribute new project templates for specific research domains
- Code Contributions: Implement new features or fix bugs
- Fork the repository
- Create a new branch for your changes (
git checkout -b feature/your-feature) - Make your changes
- Test your changes thoroughly
- Commit your changes (
git commit -am 'Add feature: your feature') - Push to your branch (
git push origin feature/your-feature) - Open a Pull Request
- Keep PRs focused on a single change
- Update documentation and comments as necessary
- Add tests for new functionality
- Ensure your code follows the existing style
- Explain what your PR does and why it should be included
- Use meaningful variable and function names
- Add comments for complex code sections
- Keep functions small and focused
- Follow bash best practices for shell scripts
Before submitting a PR, please test your changes:
- Run the
install.shscript in a test environment - Test all affected functionality (e.g., creating experiments, projects)
- Test on different platforms if possible (Linux, macOS, Windows/WSL)
By contributing, you agree that your contributions will be licensed under the project's MIT License.