-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
51 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,63 @@ | ||
|  | ||
|  | ||
|
|
||
| Building CFLint | ||
| ==================== | ||
| # Building CFLint | ||
|
|
||
| ## Quick Start | ||
|
|
||
| # Quick Start | ||
| git clone https://github.com/cflint/CFLint.git | ||
| cd CFLint | ||
| git checkout dev | ||
| gradlew clean build | ||
| CFLint will be built to build\libs | ||
|
|
||
| # Using Eclipse | ||
| ## Using Eclipse | ||
|
|
||
| Start eclipse | ||
| Help>Eclipse Marketplace | ||
| Install 'BuildShip' for Gradle integration | ||
| ## Eclipse - Import existing project | ||
|
|
||
| ### Eclipse - Import existing project | ||
|
|
||
| File>New>Other>Gradle>Gradle Project | ||
| Name the project, uncheck 'Use default location', browse to your git clone. | ||
| ## OR, Eclipse - check out with eGit | ||
|
|
||
| ### OR, Eclipse - check out with eGit | ||
|
|
||
| Window>Show View>Git Repositories | ||
| past the git url for CFLint | ||
| CFLint>Branches>Remote Tracking>origin/dev | ||
| right click on origin/dev and checkout. | ||
|
|
||
| ## Eclipse - Refresh and Build Eclipse CFLint project | ||
|
|
||
| ### Eclipse - Refresh and Build Eclipse CFLint project | ||
|
|
||
| Right click on CFLint in the project navigator, | ||
| Gradle>Refresh Gradle Project. | ||
| (use when the build.gradle file changes) | ||
|
|
||
| ## Eclipse - Running Junit tests | ||
|
|
||
| ### Eclipse - Running JUnit tests | ||
|
|
||
| Right click on src/test/java/com/cflint/integration/TestFiles.java | ||
| Run As>JUnit Test | ||
| This will run most the majority of the unit tests. | ||
|
|
||
| # Adding a Junit test | ||
|
|
||
| ## Adding a JUnit test | ||
|
|
||
| The best way to add a new test to the CFLint test suite is to add it to: | ||
|
|
||
| src\test\resources\com\cflint\tests\ | ||
| as pure CF code. Give the file a name that describes the scenario you are testing and a '.cfm' or '.cfc' extension. The first time you run TestFiles, the build will create | ||
| a file with the same name as your input, but with an extension of ".expected.txt". Future runs will only pass if the actual results match the | ||
|
|
||
| as pure CF code. Give the file a name that describes the scenario you are testing and a `.cfm` or `.cfc` extension. The first time you run TestFiles, the build will create | ||
| a file with the same name as your input, but with an extension of `.expected.txt`. Future runs will only pass if the actual results match the | ||
| expected file. | ||
| For CFLint, this is better practice than writing the JUnit test yourself. | ||
|
|
||
| # Contributing. | ||
| ## Contributing | ||
|
|
||
| Contributions are welcome. Here's how you make your first code or test contributions: | ||
| * Fork CFLint on github. | ||
| * Make your changes in the dev branch. | ||
| * Push your changes to your github repo. | ||
| * Create a pull request. | ||
|
|
||
| * Fork CFLint on GitHub. | ||
| * Make your changes in a local branch created from the `dev` branch. | ||
| * Push your changes to your GitHub repo. | ||
| * Create a pull request targeting the `dev` branch of the main repository. | ||
|
|
||
| Also see [CONTRIBUTING.md](/CONTRIBUTING.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,21 @@ | ||
|  | ||
|  | ||
|
|
||
| Code of Conduct | ||
| =============== | ||
| # Code of Conduct | ||
|
|
||
| ## TL;DR | ||
|
|
||
| ### TL;DR | ||
| Don't be a dick! | ||
|
|
||
| ### What we stand for | ||
| ## What we stand for | ||
|
|
||
| CFLint is a project developed and worked on by volunteers. Please be nice and considerate, we're here to help. We really appreciate fixes and improvements, feel free to talk to us and/or provide pull requests. | ||
| CFLint is a project developed and worked on by volunteers. Please be nice and considerate -- we're here to help. We really appreciate fixes and improvements, so feel free to talk to us and/or provide pull requests. | ||
|
|
||
| This is a place where considerate positive people, who enjoy fun and care about their craft and its impact, come together to code, learn, talk, hang out and build a product for the greater good of the CFML community. | ||
|
|
||
| We're inclusive and harassment-free based on treating everyone with respect and kindness, regardless of gender, sexual orientation, age, physical ability or appearance, ethnicity or religious beliefs. | ||
|
|
||
| We try to do everything we can to ensure that only the good stuff happens. If somebody violates that, or makes you feel uncomfortable or unsafe in any way, please let us know. We’ll take it seriously and their behaviour will be dealt with as deemed necessary. They’ll certainly be asked to stop the inappropriate behaviour and will be expected to comply immediately. It may also include ejection from the project. | ||
| We try to do everything we can to ensure that only the good stuff happens. If somebody violates that, or makes you feel uncomfortable or unsafe in any way, please let us know. We'll take it seriously and their behaviour will be dealt with as deemed necessary. They'll certainly be asked to stop the inappropriate behaviour and will be expected to comply immediately. It may also include ejection from the project. | ||
|
|
||
| We respect all participants, and assume everyone joins in good faith. We won’t attempt to list all the behaviours that are unacceptable and inappropriate when you are interacting with your peers, in case we inadvertently exclude the one very thing leads to an incident. To quote the folks from the Kiwicon conference, the “inventive genius of random assholes” is limitless. It surely goes without saying however, that offensive comments, intimidation, stalking, sustained disruption of discussions and unwelcome sexual attention are totally inappropriate. | ||
| We respect all participants, and assume everyone joins in good faith. We won't attempt to list all the behaviours that are unacceptable and inappropriate when you are interacting with your peers, in case we inadvertently exclude the one very thing leads to an incident. To quote the folks from the Kiwicon conference, the “inventive genius of random assholes” is limitless. It surely goes without saying however, that offensive comments, intimidation, stalking, sustained disruption of discussions and unwelcome sexual attention are totally inappropriate. | ||
|
|
||
| If you have any concerns whatsoever, about the comfort and safety of yourself or someone else, please contact [Ryan](https://github.com/ryaneberly) or [Kai](https://github.com/TheRealAgentK) at any time. | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,19 @@ | ||
|  | ||
|  | ||
|
|
||
| Contributing to CFLint | ||
| ====================== | ||
| # Contributing to CFLint | ||
|
|
||
| # Project and library organisation | ||
| ## Project and library organisation | ||
|
|
||
| CFLint is a project developed and worked on by volunteers. When logging issues please be nice and considerate, we're here to help. We really appreciate fixes and improvements, feel free to talk to us and/or provide pull requests. | ||
| CFLint is a project developed and worked on by volunteers. When logging issues please be nice and considerate -- we're here to help. We really appreciate fixes and improvements, so feel free to talk to us and/or provide pull requests. | ||
|
|
||
| /src/main contains the source code. Tests can be found in /src/test. CFLint relies heavily on the [CFParser](https://github.com/cfparser/cfparser) project as well as a bunch of 3rd party Java libraries. | ||
| `/src/main` contains the source code. Tests can be found in `/src/test`. CFLint relies heavily on the [CFParser](https://github.com/cfparser/cfparser) project as well as a bunch of 3rd party Java libraries. | ||
|
|
||
| The master branch is considered our stable codebase. Most of the development happens in the dev branch resp. local development branches for specific issues. | ||
| The `master` branch is considered our stable codebase. Most of the development happens in the `dev` branch resp. local development branches for specific issues. | ||
|
|
||
| # How to contribute? | ||
| ## How to contribute? | ||
|
|
||
| The main repository of this project is https://github.com/cflint/CFLint. | ||
| The main repository of this project is <https://github.com/cflint/CFLint>. | ||
|
|
||
| Please fork from there, create a local dev branch from origin/dev (named so that it explains the work in the branch), and submit a pull request against the main repository's dev branch. Even better, get in touch with us here on Github before you undertake any work so that it can be coordinated with what we're doing. | ||
| Please fork from there, create a local dev branch from `origin/dev` (named so that it explains the work in the branch), and submit a pull request against the main repository's `dev` branch. Even better, get in touch with us here on GitHub before you undertake any work so that it can be coordinated with what we're doing. | ||
|
|
||
| If you're interested in contributing on a regular basis, get in touch with [Ryan](https://github.com/ryaneberly) and we can add you to the internal CFLint Slack team. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
|  | ||
|  | ||
|
|
||
| # CFLint | ||
|
|
||
|
|
||
File renamed without changes