Skip to content

Commit 1dfd73e

Browse files
lmajanolmajano
committed
Merge branches 'development' and 'master' of github.com:coldbox-modules/cbsecurity
2 parents b49ef20 + ee027d3 commit 1dfd73e

File tree

13 files changed

+441
-202
lines changed

13 files changed

+441
-202
lines changed

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
<!-- Thanks for reporting an issue! Please fill out the blanks below. -->
7+
8+
## What are the steps to reproduce this issue?
9+
10+
1. …
11+
2. …
12+
3. …
13+
14+
## What happens?
15+
16+
…
17+
18+
## What were you expecting to happen?
19+
20+
…
21+
22+
## Any logs, error output, etc?
23+
24+
…
25+
26+
## Any other comments?
27+
28+
…
29+
30+
## What versions are you using?
31+
32+
**Operating System:** …
33+
**Package Version:** …

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature Request
3+
about: Request a new feature or enhancement
4+
---
5+
6+
<!-- Thanks for taking the time to recommend a feature! Please fill out the form below -->
7+
8+
## Summary
9+
10+
<!-- High level description of what this feature is -->
11+
12+
## Detailed Description
13+
14+
<!-- Lets get into the weeds here -->
15+
16+
## Possible Implementation Ideas
17+
18+
<!-- If you already have some idea of how to implement this, this would be the place to put it -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Description
2+
3+
Please include a summary of the changes and which issue(s) is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
**Please note that all PRs must have tests attached to them**
6+
7+
IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
8+
9+
## Issues
10+
11+
All PRs must have an accompanied issue. Please make sure you created it and linked it here.
12+
13+
## Type of change
14+
15+
Please delete options that are not relevant.
16+
17+
- [ ] Bug Fix
18+
- [ ] Improvement
19+
- [ ] New Feature
20+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
21+
- [ ] This change requires a documentation update
22+
23+
## Checklist
24+
25+
- [ ] My code follows the style guidelines of this project [cfformat](../.cfformat.json)
26+
- [ ] I have commented my code, particularly in hard-to-understand areas
27+
- [ ] I have made corresponding changes to the documentation
28+
- [ ] I have added tests that prove my fix is effective or that my feature works
29+
- [ ] New and existing unit tests pass locally with my changes

‎.vscode/settings.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
{
22
"cflint.enabled": false,
3+
"cfml.mappings": [
4+
{
5+
"logicalPath": "/coldbox",
6+
"directoryPath": "./coldbox",
7+
"isPhysicalDirectoryPath" :false
8+
},
9+
{
10+
"logicalPath": "/testbox",
11+
"directoryPath": "./testbox",
12+
"isPhysicalDirectoryPath" :false
13+
}
14+
],
315
"sqltools.connections": [
416
{
517
"mysqlOptions": {

‎.vscode/tasks.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "Run CommandBox Task",
6+
"type": "shell",
7+
"command": "box task run ${relativeFile}",
8+
"group": {
9+
"kind": "build",
10+
"isDefault": true
11+
},
12+
"presentation": {
13+
"reveal": "always",
14+
"panel": "new"
15+
},
16+
"problemMatcher": []
17+
},
18+
{
19+
"label": "Run TestBox Bundle",
20+
"type": "shell",
21+
"command": "box testbox run bundles=${relativeFile}",
22+
"group": {
23+
"kind": "build",
24+
"isDefault": true
25+
},
26+
"presentation": {
27+
"reveal": "always",
28+
"panel": "new"
29+
},
30+
"problemMatcher": []
31+
}
32+
]
33+
}

‎CONTRIBUTING.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# CBSecurity Contributing Guide
2+
3+
Hola amigo! I'm really excited that you are interested in contributing to our project. 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+
- [Security Vulnerabilities](#security-vulnerabilities)
9+
- [Language Compatibility](#language-compatibility)
10+
- [Coding Styles \& Formatting](#coding-styles--formatting)
11+
- [CFC Docs With DocBox](#cfc-docs-with-docbox)
12+
- [Financial Contributions](#financial-contributions)
13+
- [Contributors](#contributors)
14+
15+
## Code Of Conduct
16+
17+
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.**
18+
19+
- 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.
20+
- Participants will be tolerant of opposing views.
21+
- 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.
22+
- 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.
23+
- When interpreting the words and actions of others, participants should always assume good intentions. Emotions cannot be derived from textual representations.
24+
- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
25+
26+
## Bug Reporting
27+
28+
Each of the main standalone frameworks in ColdBox has its separate locations for submitting bug reports. Please make sure also that if you submit a pull request, you link it to the appropriate issue.
29+
30+
https://github.com/coldbox-modules/cbsecurity
31+
32+
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.
33+
34+
## Support Questions
35+
36+
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.
37+
38+
- Ortus Community Discourse: https://community.ortussolutions.com/
39+
- Box Slack Team : https://boxteam.ortussolutions.com/
40+
- Professional Support : https://www.ortussolutions.com/services/support
41+
42+
## Security Vulnerabilities
43+
44+
If you discover a security vulnerability, please send an email to the development 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.
45+
46+
## Language Compatibility
47+
48+
Please make sure your code runs on the following CFML Engines:
49+
50+
- Lucee 5+
51+
- Adobe ColdFusion 2018+
52+
53+
## Coding Styles & Formatting
54+
55+
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:
56+
57+
```bash
58+
# Format everything
59+
box run-script format
60+
61+
# Start a watcher, type away, save and auto-format for you
62+
box run-script format: watch
63+
```
64+
65+
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.
66+
67+
You can also see the Ortus Coding Standards you must follow here: https://github.com/Ortus-Solutions/coding-standards.
68+
69+
## CFC Docs With DocBox
70+
71+
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
72+
73+
## Financial Contributions
74+
75+
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.
76+
77+
- [Become a backer or sponsor on Patreon](https://www.patreon.com/ortussolutions)
78+
- [One-time donations via PayPal](https://www.paypal.com/paypalme/ortussolutions)
79+
80+
## Contributors
81+
82+
Thank you to all the people who have already contributed to ColdBox! We: heart: : heart: : heart: love you!
83+
84+
<a href = "https://github.com/coldbox-modules/cbsecurity/graphs/contributors">
85+
<img src = "https://contrib.rocks/image?repo=coldbox-modules/cbsecurity"/>
86+
</a>
87+
88+
Made with [contributors-img](https://contrib.rocks)

‎box.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name":"ColdBox Security",
3-
"version":"3.1.0",
3+
"version":"3.2.0",
44
"location":"https://downloads.ortussolutions.com/ortussolutions/coldbox-modules/cbsecurity/@build.version@/[email protected]@.zip",
55
"author":"Ortus Solutions.com <[email protected]>",
66
"slug":"cbsecurity",

0 commit comments

Comments
 (0)