Skip to content

Commit 56f81b9

Browse files
NEW: @W-15652642@ - Add in starting files to prepare monorepo (#9)
1 parent 6419a87 commit 56f81b9

22 files changed

+5970
-3
lines changed

.github/workflows/verify-pr.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,18 @@ jobs:
1111
if: github.base_ref == 'dev'
1212
run: |
1313
title="${{ github.event.pull_request.title }}"
14-
if [[ "$title" =~ ^(FIX|CHANGE|NEW)([[:space:]]*\([^()]+\))?[[:space:]]*:?[[:space:]]*@W-[[:digit:]]{8,9}@[[:space:]]*[:-]+.+ ]]; then
14+
if [[ "$title" =~ ^(FIX|CHANGE|NEW)([[:space:]]*\([^()]+\))?[[:space:]]*:?[[:space:]]*@W-[[:digit:]]{8,9}@[[:space:]]*.+ ]]; then
1515
echo "Valid PR title: '$title'"
1616
else
1717
echo "::error::Invalid PR title: '$title'. Please following the format: FIX|CHANGE|NEW (__) @W-XXXXXXXX@ Summary"
1818
exit 1
19-
fi
19+
fi
20+
run_tests:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v4
24+
- uses: actions/setup-node@v4
25+
with:
26+
node-version: 20
27+
- run: npm install
28+
- run: npm run all

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
.DS_Store
22
.idea/
3-
node_modules/
3+
node_modules/
4+
dist/
5+
coverage/
6+
*.tsbuildinfo
7+
*.tgz

CONTRIBUTING.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Contributing Guide
2+
> Currently, we aren't accepting external contributions. To know when we open for contributions, periodically check this guide.
3+
4+
To contribute, read this guide to understand its operational governance model. This guide also provides contribution requirements and recommendations. Thanks for your interest and contributions.
5+
6+
# Governance Model
7+
8+
## Salesforce Sponsored
9+
10+
The intent and goal of open sourcing this project is to increase the contributor and user base. Note that Salesforce employees have `admin` rights and are the final arbiters which contributions are accepted.
11+
12+
# Issues, requests & ideas
13+
14+
To submit issues, enhancement requests, and discuss ideas, create an issue on the [Issues page](https://github.com/forcedotcom/code-analyzer-core/issues).
15+
16+
### Bug Reports and Fixes
17+
- If you find a bug, search for it in the [Issues](https://github.com/forcedotcom/code-analyzer-core/issues), and if it isn't already tracked,
18+
[create a new issue](https://github.com/forcedotcom/code-analyzer-core/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.
19+
- Issues that have been confirmed as a bug will be labelled `bug`.
20+
- If you want to submit a bug fix, [create a pull request](#creating_a_pull_request) and mention the issue number.
21+
- In your bug fix pull request, include tests that isolate the bug and verify that it's fixed.
22+
23+
### New Features
24+
- To add new functionality, describe the problem you want to solve - or the enhancement you identifed - in a [new issue](https://github.com/forcedotcom/code-analyzer-core/issues/new).
25+
- Issues that are identified as a feature request are labelled `enhancement`.
26+
- Before writing the code for your newly requested feature, first wait for feedback from the project maintainers. In some cases, requested `enhancements` don't align well with the current project objectives.
27+
28+
### Tests, Documentation, Miscellaneous
29+
- We welcome your contributions to:
30+
- improving tests
31+
- clarifying documentation
32+
- requesting alternative implementations
33+
- If it's a trivial change, go ahead and [create a pull request](#creating_a_pull_request) with the changes you have in mind.
34+
- If your request is larger in size, [open an issue](https://github.com/forcedotcom/code-analyzer-core/issues/new) to get feedback on your idea.
35+
36+
# Contribution Checklist
37+
38+
- [x] Clean, simple, well styled code
39+
- [x] Atomic commits and descriptive messages. Mention related issues by issue number
40+
- [x] Comments
41+
- Module-level & function-level comments
42+
- Comments on complex blocks of code or algorithms (include references to sources)
43+
- [x] Tests
44+
- Complete, passing test suite test suite (if provided)
45+
- Maintain or increase code coverage percentages
46+
- [x] Dependencies
47+
- Minimize number of dependencies
48+
- Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses
49+
- [x] Reviews
50+
- Approved peer code review changes
51+
52+
# Local Development
53+
54+
## Install Dependencies
55+
Install required node dependencies:
56+
```
57+
npm install
58+
```
59+
60+
## Building Code
61+
Build the source code with:
62+
```
63+
npm run build
64+
```
65+
66+
## Running Tests
67+
We strive for 100% code coverage.
68+
After making your changes, run your tests and check coverage with:
69+
```
70+
npm run test
71+
```
72+
73+
# Creating a Pull Request
74+
75+
1. **Ensure the bug or feature wasn't 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 or fix and offer suggestions, or let you know if there is already an effort in progress.
76+
3. **Clone** the forked repo to your machine.
77+
4. **Create** a new branch to contain your work. Example: `git br fix-issue-11`
78+
4. **Commit** changes to your own branch.
79+
5. **Push** your work back up to your fork. Example: `git push fix-issue-11`
80+
6. **Submit** a pull request against the `main` branch and refer to the issue you're fixing. Keep your pull request simple and small to avoid any unintended changes.
81+
7. **Sign** the Salesforce Contributor License Agreement (CLA). You will be prompted to do so when submitting your pull request.
82+
83+
> **NOTE**: Be sure to [sync your fork](https://help.github.com/articles/syncing-a-fork/) before making a pull request.
84+
85+
86+
# Code of Conduct
87+
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
88+
89+
# License
90+
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)

0 commit comments

Comments
 (0)