-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
@W-14689557@: Update README.md and CONTRIBUTING.md
- Loading branch information
1 parent
8cb5489
commit 54fa23d
Showing
3 changed files
with
165 additions
and
5 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,3 +1,93 @@ | ||
| # Contributing Guide | ||
| > At the moment, we are not accepting external contributions. Please watch this space to know when we open. | ||
| # Contributing Guide for the 'Run Salesforce Code Analyzer' GitHub Action | ||
| > Currently, we aren't accepting external contributions. To know when we open for contributions, periodically check this guide. | ||
| This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to the 'Run Salesforce Code Analyzer' GitHub Action. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes. | ||
|
|
||
| # Governance Model | ||
|
|
||
| ## Salesforce Sponsored | ||
|
|
||
| The intent and goal of open sourcing this project is to increase the contributor and user base. However, only Salesforce employees will be given `admin` rights and will be the final arbitrars of what contributions are accepted or not. | ||
|
|
||
| # Issues, requests & ideas | ||
|
|
||
| Use GitHub Issues page to submit issues, enhancement requests and discuss ideas. | ||
|
|
||
| ### Bug Reports and Fixes | ||
| - If you find a bug, please search for it in the [Issues](https://github.com/forcedotcom/run-code-analyzer/issues), and if it isn't already tracked, | ||
| [create a new issue](https://github.com/forcedotcom/run-code-analyzer/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still | ||
| be reviewed. | ||
| - Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`. | ||
| - If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number. | ||
| - Include tests that isolate the bug and verifies that it was fixed. | ||
|
|
||
| ### New Features | ||
| - If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/forcedotcom/run-code-analyzer/issues/new). | ||
| - Issues that have been identified as a feature request will be labelled `enhancement`. | ||
| - If you'd like to implement the new feature, please wait for feedback from the project | ||
| maintainers before spending too much time writing the code. In some cases, `enhancement`s may | ||
| not align well with the project objectives at the time. | ||
|
|
||
| ### Tests, Documentation, Miscellaneous | ||
| - If you'd like to improve the tests, you want to make the documentation clearer, you have an | ||
| alternative implementation of something that may have advantages over the way its currently | ||
| done, or you have any other change, we would be happy to hear about it! | ||
| - If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind. | ||
| - If not, [open an Issue](https://github.com/forcedotcom/run-code-analyzer/issues/new) to discuss the idea first. | ||
|
|
||
| # Contribution Checklist | ||
|
|
||
| - [x] Clean, simple, well styled code | ||
| - [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number. | ||
| - [x] Comments | ||
| - Module-level & function-level comments. | ||
| - Comments on complex blocks of code or algorithms (include references to sources). | ||
| - [x] Tests | ||
| - The test suite, if provided, must be complete and pass | ||
| - Increase code coverage, not versa. | ||
| - [x] Dependencies | ||
| - Minimize number of dependencies. | ||
| - Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses. | ||
| - [x] Reviews | ||
| - Changes must be approved via peer code review | ||
|
|
||
| # Local development | ||
|
|
||
| ## Install dependencies | ||
| Install required node dependencies: | ||
| ``` | ||
| npm install | ||
| ``` | ||
|
|
||
| ## Running tests | ||
| We strive for 100% code coverage. | ||
| After making your changes, run your tests and check coverage with: | ||
| ``` | ||
| npm run test | ||
| ``` | ||
|
|
||
| ## Before submitting | ||
| We use `ncc` to produce a single *index.js* file inside the *dist* directory from all the typescript source code. | ||
| Therefore, before you can submit, you must create this package along with license files, and badges with: | ||
| ``` | ||
| npm run all | ||
| ``` | ||
|
|
||
| # Creating a Pull Request | ||
|
|
||
| 1. **Ensure the bug/feature was not already reported** by searching on GitHub under Issues. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress). | ||
| 3. **Clone** the forked repo to your machine. | ||
| 4. **Create** a new branch to contain your work (e.g. `git br fix-issue-11`) | ||
| 4. **Commit** changes to your own branch. | ||
| 5. **Push** your work back up to your fork. (e.g. `git push fix-issue-11`) | ||
| 6. **Submit** a Pull Request against the `main` branch and refer to the issue(s) you are fixing. Try not to pollute your pull request with unintended changes. Keep it simple and small. | ||
| 7. **Sign** the Salesforce CLA (you will be prompted to do so when submitting the Pull Request) | ||
|
|
||
| > **NOTE**: Be sure to [sync your fork](https://help.github.com/articles/syncing-a-fork/) before making a pull request. | ||
|
|
||
| # Code of Conduct | ||
| Please follow our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
|
||
| # License | ||
| By contributing your code, you agree to license your contribution under the terms of our project [LICENSE](LICENSE) and to sign the [Salesforce CLA](https://cla.salesforce.com/sign-cla) |
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,9 +1,79 @@ | ||
| # Coming soon | ||
| # Run Salesforce Code Analyzer - GitHub Action | ||
|
|
||
| [](https://github.com/super-linter/super-linter) | ||
|  | ||
| [](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml) | ||
| [](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml) | ||
| [](./badges/coverage.svg) | ||
|
|
||
| This GitHub action will be available in the coming weeks. When available, we will update this README.md file. | ||
| The `run-code-analyzer` GitHub Action scans your code for violations using | ||
| [Salesforce Code Analyzer](https://forcedotcom.github.io/sfdx-scanner), uploads the results as an artifact, and displays | ||
| the results as a job summary. | ||
|
|
||
| # Inputs | ||
| * `run-command` (Default value: `'run'`) | ||
| * <b>Specifies the Salesforce Code Analyzer command to run.</b><br/> | ||
| Possible values are: `'run'`, `'run dfa'`.<br/> | ||
| * For more info on Code Analyzer, read our [documentation](https://forcedotcom.github.io/sfdx-scanner). | ||
| * `run-arguments` (Default value: `'--normalize-severity'`) | ||
| * <b>Specifies arguments passed to the specified `run-command` value.</b><br/> | ||
| The arguments provided must include `--normalize-severity`.<br/> | ||
| To control the output file included in the uploaded artifact, specify an output file name with the `--outfile` argument.<br/> | ||
| If an output file isn’t specified, results are written to GitHub workflow run logs and a | ||
| *SalesforceCodeAnalyzerResults.json* file is included in the uploaded artifact. | ||
| * For a full list of acceptable arguments, read the appropriate Command Reference: | ||
| * [sf scanner run](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/scanner-commands/run) | ||
| * [sf scanner run dfa](https://forcedotcom.github.io/sfdx-scanner/en/v3.x/scanner-commands/dfa) | ||
| * `results-artifact-name` (Default: `'code-analyzer-results'`) | ||
| * <b>Specifies the name of the zip archive job artifact where the results output file is uploaded.</b> | ||
|
|
||
| # Outputs | ||
| * `exit-code` | ||
| * The Salesforce Code Analyzer execution exit code. | ||
| * `num-violations` | ||
| * The total number of violations found. | ||
| * `num-sev1-violations` | ||
| * The number of normalized high-severity violations found. | ||
| * `num-sev2-violations` | ||
| * The number of normalized medium-severity violations found. | ||
| * `num-sev3-violations` | ||
| * The number of normalized low-severity violations found. | ||
|
|
||
| This `run-code-analyzer` action will not exit your GitHub workflow when violations are found. Instead, we recommend adding a | ||
| subsequent step to your workflow that uses these outputs to determine how your workflow should proceed. | ||
| See the example below. | ||
|
|
||
| # Example Usage | ||
|
|
||
| name: Salesforce Code Analyzer Workflow | ||
| on: push | ||
| jobs: | ||
| salesforce-code-analyzer-workflow: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out files | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Install the Salesforce CLI | ||
| run: npm install -g @salesforce/cli@latest | ||
|
|
||
| - name: Install the Salesforce Code Analyzer Plugin | ||
| run: sf plugins install @salesforce/sfdx-scanner@latest | ||
|
|
||
| - name: Run the Salesforce Code Analyzer | ||
| id: run-code-analyzer | ||
| uses: forcedotcom/run-code-analyzer@v1 | ||
| with: | ||
| run-command: run | ||
| run-arguments: --normalize-severity --outfile results.html | ||
| results-artifact-name: salesforce-code-analyzer-results | ||
|
|
||
| - name: Check the outputs to determine whether to fail | ||
| if: | | ||
| steps.run-code-analyzer.outputs.exit-code > 0 || | ||
| steps.run-code-analyzer.outputs.num-sev1-violations > 0 || | ||
| steps.run-code-analyzer.outputs.num-violations > 10 | ||
| run: exit 1 | ||
|
|
||
| # Contributing | ||
| To contribute to this `run-code-analzer` GitHub Action, see [CONTRIBUTING.md](https://github.com/forcedotcom/run-code-analyzer/blob/main/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