Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
fdb7b6c
version bump
lmajano Nov 15, 2022
ed20332
🐛 FIX: Update GHA to avoid deprecated syntax (#67)
michaelborn Dec 20, 2022
37ab311
New [Contributing](CONTRIBUTING.md) guidelines
lmajano Apr 13, 2023
640990f
Consolidated Adobe 2021 scripts into the server scripts
lmajano Apr 13, 2023
10e934a
- Fix for `tasks.json` file to include no recursion
lmajano Apr 13, 2023
dcb2a35
- New github support templates
lmajano Apr 13, 2023
c9d306f
New github action versions and consolidation of actions
lmajano Apr 13, 2023
aad99e2
Apply cfformat changes
lmajano Apr 13, 2023
4d455fc
fixing ci
lmajano Apr 13, 2023
1bd4424
Merge branch 'development' of github.com:coldbox-modules/cbvalidation…
lmajano Apr 13, 2023
f11af04
- #71 - ValidationManager errors when returning `validatedKeys` due t…
lmajano Apr 13, 2023
e56689e
more trying
lmajano Apr 13, 2023
e0e9626
resolves #45 - `Type` validator needs to be able to validate against …
lmajano Apr 13, 2023
9e6db4c
adding debugging
lmajano Apr 13, 2023
05bcdb7
more tests
lmajano Apr 13, 2023
8af1b1d
more tests
lmajano Apr 13, 2023
c0e4cd5
oops
lmajano Apr 13, 2023
5ff9220
ok done
lmajano Apr 13, 2023
c41d816
ok prepping for new and improved master release
lmajano Apr 13, 2023
9f74b1f
oops
lmajano Apr 13, 2023
7c89c03
adding coldbox be testing
lmajano Apr 14, 2023
a594ee6
fixing be builds
lmajano Apr 14, 2023
0efc5f9
typos
lmajano Apr 14, 2023
5e1497b
- The way custom validators are retrieved so they are ColdBox 7+ comp…
lmajano Apr 14, 2023
b215ca0
Apply cfformat changes
lmajano Apr 14, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
New [Contributing](CONTRIBUTING.md) guidelines
  • Loading branch information
lmajano committed Apr 13, 2023
commit 37ab3118ab3466fa95065d8c55e977a26b432288
108 changes: 108 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# Contributing Guide

Hola amigo! I'm really excited that you are interested in contributing to cbvalidation. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

- [Code Of Conduct](#code-of-conduct)
- [Bug Reporting](#bug-reporting)
- [Support Questions](#support-questions)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Security Vulnerabilities](#security-vulnerabilities)
- [Development Setup](#development-setup)
- [Language Compatibility](#language-compatibility)
- [Coding Styles \& Formatting](#coding-styles--formatting)
- [CFC Docs With DocBox](#cfc-docs-with-docbox)
- [Financial Contributions](#financial-contributions)
- [Contributors](#contributors)

## Code Of Conduct

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.**

- 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.
- Participants will be tolerant of opposing views.
- 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.
- 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.
- When interpreting the words and actions of others, participants should always assume good intentions. Emotions cannot be derived from textual representations.
- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.


## Bug Reporting

Please make sure also that if you submit a pull request, you link it to the appropriate issue(s).

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.

## Support Questions

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.

- Ortus Community Discourse: https://community.ortussolutions.com
- Box Slack Team: http://boxteam.ortussolutions.com/
- Professional Support: https://www.ortussolutions.com/services/support

## Pull Request Guidelines

- 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.
- All pull requests should be sent to the `development` branch or the appropriate LTS branch (`releases/v{version}`).
- It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging.
- Make sure all local tests pass before submitting the merge.
- Please make sure all your pull requests have companion tests.
- Please link the Jira issue in your PR title when sending the final PR

## Security Vulnerabilities

If you discover a security vulnerability, please send an email to the Ortus security team at [[email protected]](mailto:[email protected]?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.

## Development Setup

1. Fork and Star our project.
2. Make sure you have CommandBox installed: https://www.ortussolutions.com/products/commandbox#download
3. Start a CommandBox shell in the root of the project: `box`
4. Install the development dependencies: `run-script install:dependencies`
5. Hack away! Create tests under `/test-harness/specs` or wherever they are set in the project and run the tests!

## Language Compatibility

Please make sure your code runs on the following CFML Engines:

- Lucee 5+
- Adobe ColdFusion 2018+

## Coding Styles & Formatting

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:

```bash
# Format everything
box run-script format

# Start a watcher, type away, save and auto-format for you
box run-script format:watch
```

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.

You can also see the Ortus Coding Standards you must follow here: https://github.com/Ortus-Solutions/coding-standards.

## CFC Docs With DocBox

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


## Financial Contributions

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.

- [Become a backer or sponsor on Patreon](https://www.patreon.com/ortussolutions)
- [One-time donations via PayPal](https://www.paypal.com/paypalme/ortussolutions)

## Contributors

Thank you to all the people who have already contributed to cbvalidation! We :heart: :heart: :heart: love you!


<a href = "https://github.com/coldbox-modules/cbvalidation/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=coldbox-modules/cbvalidation"/>
</a>

Made with [contributors-img](https://contrib.rocks)