|
1 | | -# Contributing to EngineScript |
2 | | - |
3 | | -Thank you for your interest in contributing to EngineScript! This document provides guidelines and information for contributors. |
4 | | - |
5 | | -## Table of Contents |
6 | | -- [Code of Conduct](#code-of-conduct) |
7 | | -- [How Can I Contribute?](#how-can-i-contribute) |
8 | | -- [Development Setup](#development-setup) |
9 | | -- [Pull Request Process](#pull-request-process) |
10 | | -- [Style Guidelines](#style-guidelines) |
11 | | - |
12 | | -## Code of Conduct |
13 | | - |
14 | | -This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. |
15 | | - |
16 | | -## How Can I Contribute? |
17 | | - |
18 | | -### Reporting Bugs |
19 | | -- Check if the bug has already been reported in [Issues](https://github.com/EngineScript/EngineScript/issues) |
20 | | -- If not, create a new issue with a clear title and description |
21 | | -- Include steps to reproduce, expected behavior, and actual behavior |
22 | | -- Add relevant system information (OS, PHP version, etc.) |
23 | | - |
24 | | -### Suggesting Enhancements |
25 | | -- First, read the [documentation](README.md) |
26 | | -- Check if the enhancement has been suggested in [Issues](https://github.com/EngineScript/EngineScript/issues) |
27 | | -- Provide a clear and detailed explanation of the feature |
28 | | - |
29 | | -### Pull Requests |
30 | | -1. Fork the repository |
31 | | -2. Create a new branch (`git checkout -b feature/your-feature`) |
32 | | -3. Make your changes |
33 | | -4. Run tests if available |
34 | | -5. Commit your changes (`git commit -m 'Add some feature'`) |
35 | | -6. Push to the branch (`git push origin feature/your-feature`) |
36 | | -7. Create a Pull Request |
37 | | - |
38 | | -## Development Setup |
39 | | - |
40 | | -1. Set up a test environment: |
41 | | -- Ubuntu 24.04 LTS server |
42 | | - |
43 | | -## Pull Request Process |
44 | | - |
45 | | -1. Update the README.md with details of changes if applicable |
46 | | -2. Update the documentation if you're changing functionality |
47 | | -3. Use semantic commit messages: |
48 | | - - `feat:` for new features |
49 | | - - `fix:` for bug fixes |
50 | | - - `docs:` for documentation changes |
51 | | - - `style:` for formatting changes |
52 | | - - `refactor:` for code restructuring |
53 | | - - `test:` for adding tests |
54 | | - - `chore:` for maintenance tasks |
55 | | - |
56 | | -## Style Guidelines |
57 | | - |
58 | | -### Shell Scripts |
59 | | -- Use 2 spaces for indentation |
60 | | -- Add comments for complex logic |
61 | | -- Use meaningful variable names |
62 | | -- Always check return values |
63 | | -- Use shellcheck for validation |
64 | | - |
65 | | -### Configuration Files |
66 | | -- Use proper indentation |
67 | | -- Add comments for non-obvious settings |
68 | | -- Keep related settings grouped together |
69 | | -- Follow the existing format |
70 | | - |
71 | | -### Documentation |
72 | | -- Use clear, concise language |
73 | | -- Include examples where appropriate |
74 | | -- Keep formatting consistent |
75 | | -- Update table of contents when needed |
76 | | - |
77 | | -## Need Help? |
78 | | - |
79 | | -Feel free to: |
80 | | -- Check our [documentation](README.md) |
81 | | -- Open an [issue](https://github.com/EngineScript/EngineScript/issues) |
82 | | -- Join our discussions |
83 | | - |
84 | | -## License |
85 | | - |
| 1 | +# Contributing to EngineScript |
| 2 | + |
| 3 | +Thank you for your interest in contributing to EngineScript! This document provides guidelines and information for contributors. |
| 4 | + |
| 5 | +## Table of Contents |
| 6 | +- [Code of Conduct](#code-of-conduct) |
| 7 | +- [How Can I Contribute?](#how-can-i-contribute) |
| 8 | +- [Development Setup](#development-setup) |
| 9 | +- [Pull Request Process](#pull-request-process) |
| 10 | +- [Style Guidelines](#style-guidelines) |
| 11 | + |
| 12 | +## Code of Conduct |
| 13 | + |
| 14 | +This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. |
| 15 | + |
| 16 | +## How Can I Contribute? |
| 17 | + |
| 18 | +### Reporting Bugs |
| 19 | +- Check if the bug has already been reported in [Issues](https://github.com/EngineScript/EngineScript/issues) |
| 20 | +- If not, create a new issue with a clear title and description |
| 21 | +- Include steps to reproduce, expected behavior, and actual behavior |
| 22 | +- Add relevant system information (OS, PHP version, etc.) |
| 23 | + |
| 24 | +### Suggesting Enhancements |
| 25 | +- First, read the [documentation](README.md) |
| 26 | +- Check if the enhancement has been suggested in [Issues](https://github.com/EngineScript/EngineScript/issues) |
| 27 | +- Provide a clear and detailed explanation of the feature |
| 28 | + |
| 29 | +### Pull Requests |
| 30 | +1. Fork the repository |
| 31 | +2. Create a new branch (`git checkout -b feature/your-feature`) |
| 32 | +3. Make your changes |
| 33 | +4. Run tests if available |
| 34 | +5. Commit your changes (`git commit -m 'Add some feature'`) |
| 35 | +6. Push to the branch (`git push origin feature/your-feature`) |
| 36 | +7. Create a Pull Request |
| 37 | + |
| 38 | +## Development Setup |
| 39 | + |
| 40 | +1. Set up a test environment: |
| 41 | +- Ubuntu 24.04 LTS server |
| 42 | + |
| 43 | +## Pull Request Process |
| 44 | + |
| 45 | +1. Update the README.md with details of changes if applicable |
| 46 | +2. Update the documentation if you're changing functionality |
| 47 | +3. Use semantic commit messages: |
| 48 | + - `feat:` for new features |
| 49 | + - `fix:` for bug fixes |
| 50 | + - `docs:` for documentation changes |
| 51 | + - `style:` for formatting changes |
| 52 | + - `refactor:` for code restructuring |
| 53 | + - `test:` for adding tests |
| 54 | + - `chore:` for maintenance tasks |
| 55 | + |
| 56 | +## Style Guidelines |
| 57 | + |
| 58 | +### Shell Scripts |
| 59 | +- Use 2 spaces for indentation |
| 60 | +- Add comments for complex logic |
| 61 | +- Use meaningful variable names |
| 62 | +- Always check return values |
| 63 | +- Use shellcheck for validation |
| 64 | + |
| 65 | +### Configuration Files |
| 66 | +- Use proper indentation |
| 67 | +- Add comments for non-obvious settings |
| 68 | +- Keep related settings grouped together |
| 69 | +- Follow the existing format |
| 70 | + |
| 71 | +### Documentation |
| 72 | +- Use clear, concise language |
| 73 | +- Include examples where appropriate |
| 74 | +- Keep formatting consistent |
| 75 | +- Update table of contents when needed |
| 76 | + |
| 77 | +## Need Help? |
| 78 | + |
| 79 | +Feel free to: |
| 80 | +- Check our [documentation](README.md) |
| 81 | +- Open an [issue](https://github.com/EngineScript/EngineScript/issues) |
| 82 | +- Join our discussions |
| 83 | + |
| 84 | +## License |
| 85 | + |
86 | 86 | By contributing to EngineScript, you agree that your contributions will be licensed under the same terms as the project. |
0 commit comments