Thank you for your interest in contributing to EngineScript! This document provides guidelines and information for contributors.
This project follows our Code of Conduct. By participating, you are expected to uphold this code.
- Check if the bug has already been reported in Issues
- If not, create a new issue with a clear title and description
- Include steps to reproduce, expected behavior, and actual behavior
- Add relevant system information (OS, PHP version, etc.)
- First, read the documentation
- Check if the enhancement has been suggested in Issues
- Provide a clear and detailed explanation of the feature
- Fork the repository
- Create a new branch (
git checkout -b feature/your-feature) - Make your changes
- Run tests if available
- Commit your changes (
git commit -m 'Add some feature') - Push to the branch (
git push origin feature/your-feature) - Create a Pull Request
- Set up a test environment:
- Ubuntu 24.04 LTS server
- Update the README.md with details of changes if applicable
- Update the documentation if you're changing functionality
- Use semantic commit messages:
feat:for new featuresfix:for bug fixesdocs:for documentation changesstyle:for formatting changesrefactor:for code restructuringtest:for adding testschore:for maintenance tasks
- Use 2 spaces for indentation
- Add comments for complex logic
- Use meaningful variable names
- Always check return values
- Use shellcheck for validation
- Use proper indentation
- Add comments for non-obvious settings
- Keep related settings grouped together
- Follow the existing format
- Use clear, concise language
- Include examples where appropriate
- Keep formatting consistent
- Update table of contents when needed
Feel free to:
- Check our documentation
- Open an issue
- Join our discussions
By contributing to EngineScript, you agree that your contributions will be licensed under the same terms as the project.