CONTRIBUTING.md (2065B)
1 # Contributing to Cloud Code Compiler 2 3 First off, thanks for taking the time to contribute! :tada: 4 5 The following is a set of guidelines for contributing to the Cloud Code Compiler project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. 6 7 ## Code of Conduct 8 9 This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. 10 11 ## How Can I Contribute? 12 13 ### Reporting Bugs 14 15 This section guides you through submitting a bug report for Cloud Code Compiler. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. 16 17 * **Use a clear and descriptive title** for the issue to identify the problem. 18 * **Describe the exact steps which reproduce the problem** in as much detail as possible. 19 * **Provide specific examples** to demonstrate the steps. 20 21 ### Suggesting Enhancements 22 23 This section guides you through submitting an enhancement suggestion for Cloud Code Compiler, including completely new features and minor improvements to existing functionality. 24 25 * **Use a clear and descriptive title** for the issue to identify the suggestion. 26 * **Provide a step-by-step description of the suggested enhancement** in as much detail as possible. 27 * **Explain why this enhancement would be useful** to most Cloud Code Compiler users. 28 29 ### Pull Requests 30 31 1. Fork the repo and create your branch from `main`. 32 2. If you've added code that should be tested, add tests. 33 3. If you've changed APIs, update the documentation. 34 4. Ensure the test suite passes. 35 5. Make sure your code lints. 36 6. Issue that pull request! 37 38 ## Styleguides 39 40 ### Python Styleguide 41 42 * Follow PEP 8 guidelines. 43 * Use comments to explain complex logic. 44 45 ### JavaScript/HTML Styleguide 46 47 * Keep code clean and readable. 48 * Use comments where necessary. 49 50 ## License 51 52 By contributing, you agree that your contributions will be licensed under its MIT License.