|
| 1 | +# Contributing Guide |
| 2 | + |
| 3 | +Hola amigo! I'm really excited that you are interested in contributing to coldbox-cli. Before submitting your contribution, please make sure to take a moment and read through the following guidelines: |
| 4 | + |
| 5 | +- [Code Of Conduct](#code-of-conduct) |
| 6 | +- [Bug Reporting](#bug-reporting) |
| 7 | +- [Support Questions](#support-questions) |
| 8 | +- [Pull Request Guidelines](#pull-request-guidelines) |
| 9 | +- [Security Vulnerabilities](#security-vulnerabilities) |
| 10 | +- [Development Setup](#development-setup) |
| 11 | +- [Language Compatibility](#language-compatibility) |
| 12 | +- [Coding Styles \& Formatting](#coding-styles--formatting) |
| 13 | +- [CFC Docs With DocBox](#cfc-docs-with-docbox) |
| 14 | +- [Financial Contributions](#financial-contributions) |
| 15 | +- [Contributors](#contributors) |
| 16 | + |
| 17 | +## Code Of Conduct |
| 18 | + |
| 19 | +This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers and/or businesses. Please be considerate towards maintainers when raising issues or presenting pull requests. **We all follow the Golden Rule: Do to others as you want them to do to you.** |
| 20 | + |
| 21 | +- As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. |
| 22 | +- Participants will be tolerant of opposing views. |
| 23 | +- Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. |
| 24 | +- Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. |
| 25 | +- When interpreting the words and actions of others, participants should always assume good intentions. Emotions cannot be derived from textual representations. |
| 26 | +- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. |
| 27 | + |
| 28 | + |
| 29 | +## Bug Reporting |
| 30 | + |
| 31 | +Please make sure also that if you submit a pull request, you link it to the appropriate issue(s). |
| 32 | + |
| 33 | +If you file a bug report, your issue should contain a title, a clear description of the issue, a way to replicate the issue, and any support files that we might need to replicate your issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix for it. All issues that do not contain a way to replicate will not be addressed. |
| 34 | + |
| 35 | +## Support Questions |
| 36 | + |
| 37 | +If you have any questions on usage, professional support or just ideas to bounce off the maintainers, please do not create an issue. Leverage our support channels first. |
| 38 | + |
| 39 | +- Ortus Community Discourse: https://community.ortussolutions.com |
| 40 | +- Box Slack Team: http://boxteam.ortussolutions.com/ |
| 41 | +- Professional Support: https://www.ortussolutions.com/services/support |
| 42 | + |
| 43 | +## Pull Request Guidelines |
| 44 | + |
| 45 | +- The `(master|main)` branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the master branch. They will be closed. |
| 46 | +- All pull requests should be sent to the `development` branch or the appropriate LTS branch (`releases/v{version}`). |
| 47 | +- It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging. |
| 48 | +- Make sure all local tests pass before submitting the merge. |
| 49 | +- Please make sure all your pull requests have companion tests. |
| 50 | +- Please link the Jira issue in your PR title when sending the final PR |
| 51 | + |
| 52 | +## Security Vulnerabilities |
| 53 | + |
| 54 | +If you discover a security vulnerability, please send an email to the Ortus security team at [security@ortussolutions.com](mailto:security@ortussolutions.com?subject=security) and make sure you report it to the `#security` channel in our Box Team Slack Channel. All security vulnerabilities will be promptly addressed. |
| 55 | + |
| 56 | +## Development Setup |
| 57 | + |
| 58 | +1. Fork and Star our project. |
| 59 | +2. Make sure you have CommandBox installed: https://www.ortussolutions.com/products/commandbox#download |
| 60 | +3. Start a CommandBox shell in the root of the project: `box` |
| 61 | +4. Install the development dependencies: `run-script install:dependencies` |
| 62 | +5. Hack away! Create tests under `/test-harness/specs` or wherever they are set in the project and run the tests! |
| 63 | + |
| 64 | +## Language Compatibility |
| 65 | + |
| 66 | +Please make sure your code runs on the following CFML Engines: |
| 67 | + |
| 68 | +- Lucee 5+ |
| 69 | +- Adobe ColdFusion 2018+ |
| 70 | + |
| 71 | +## Coding Styles & Formatting |
| 72 | + |
| 73 | +We are big on coding styles and have included a `.cfformat.json` in the root of the project so that you can run the formatting tools and CommandBox scripts: |
| 74 | + |
| 75 | +```bash |
| 76 | +# Format everything |
| 77 | +box run-script format |
| 78 | + |
| 79 | +# Start a watcher, type away, save and auto-format for you |
| 80 | +box run-script format:watch |
| 81 | +``` |
| 82 | + |
| 83 | +We recommend that anytime you hack on the core you start the formatter watcher (`box run-script format:watch`). This will monitor your changes and auto-format your code for you. |
| 84 | + |
| 85 | +You can also see the Ortus Coding Standards you must follow here: https://github.com/Ortus-Solutions/coding-standards. |
| 86 | + |
| 87 | +## CFC Docs With DocBox |
| 88 | + |
| 89 | +All CFCs are self-documenting and we leverage [DocBox](https://docbox.ortusbooks.com/) to document the entire software. All functions must be properly documented using the DocBox syntax: https://docbox.ortusbooks.com/getting-started/annotating-your-code |
| 90 | + |
| 91 | + |
| 92 | +## Financial Contributions |
| 93 | + |
| 94 | +You can support ColdBox and all of our Open Source initiatives at Ortus Solutions by becoming a patreon. You can also get lots of goodies and services depending on the level of contributions. |
| 95 | + |
| 96 | +- [Become a backer or sponsor on Patreon](https://www.patreon.com/ortussolutions) |
| 97 | +- [One-time donations via PayPal](https://www.paypal.com/paypalme/ortussolutions) |
| 98 | + |
| 99 | +## Contributors |
| 100 | + |
| 101 | +Thank you to all the people who have already contributed to coldbox-cli! We :heart: :heart: :heart: love you! |
| 102 | + |
| 103 | + |
| 104 | +<a href = "https://github.com/coldbox/coldbox-cli/graphs/contributors"> |
| 105 | + <img src = "https://contrib.rocks/image?repo=coldbox/coldbox-cli"/> |
| 106 | +</a> |
| 107 | + |
| 108 | +Made with [contributors-img](https://contrib.rocks) |
0 commit comments