Thank you for your interest in contributing to EngineScript! This document provides guidelines and information for contributors.

• Code of Conduct
• How Can I Contribute?
• Development Setup
• Pull Request Process
• Style Guidelines

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

1. Fork the repository
2. Create a new branch (git checkout -b feature/your-feature)
3. Make your changes
4. Run tests if available
5. Commit your changes (git commit -m 'Add some feature')
6. Push to the branch (git push origin feature/your-feature)
7. Create a Pull Request

1. Set up a test environment:

• Ubuntu 24.04 LTS server

1. Update the README.md with details of changes if applicable
2. Update the documentation if you're changing functionality
3. Use semantic commit messages:
   • feat: for new features
   • fix: for bug fixes
   • docs: for documentation changes
   • style: for formatting changes
   • refactor: for code restructuring
   • test: for adding tests
   • chore: 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.