Skip to content

Commit 0b7a158

Browse files
committed
Enhance CONTRIBUTING.md and update dependencies
- Added a contents section to the CONTRIBUTING.md file for better navigation. - Included detailed instructions for running development checks and automated tests before submitting pull requests. - Updated package.json and package-lock.json to include `vitest` as a new dependency for testing. - Corrected the link to the CONTRIBUTING.md file in the README.md for improved accessibility. These changes aim to improve the contribution process and enhance the development workflow.
1 parent 3ea80b6 commit 0b7a158

4 files changed

Lines changed: 43 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This document describes the contribution process and governance policies of the FINOS Electron FDC3 Desktop Agent & App Directory project. The project is also governed by the [Linux Foundation Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), and the FINOS [IP Policy](https://github.com/finos/community/blob/master/governance/IP-Policy.pdf), [Code of Conduct](https://github.com/finos/community/blob/master/governance/Code-of-Conduct.md), [Collaborative Principles](https://github.com/finos/community/blob/master/governance/Collaborative-Principles.md), and [Meeting Procedures](https://github.com/finos/community/blob/master/governance/Meeting-Procedures.md).
44

5+
**Contents:** [Contribution process](#contribution-process) · [Development, checks, and automated tests](#development-checks-and-automated-tests) · [Security](#reporting-security-issues) · [Governance](#governance)
6+
57
## Contribution Process
68

79
Before making a contribution, please take the following steps:
@@ -14,6 +16,40 @@ Before making a contribution, please take the following steps:
1416

1517
NOTE: All contributors must have a contributor license agreement (CLA) on file with FINOS before their pull requests will be merged. Please review the FINOS [contribution requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements) and submit (or have your employer submit) the required CLA before submitting a pull request.
1618

19+
## Development, checks, and automated tests
20+
21+
For build and run instructions (browser and Electron), see the [README](README.md).
22+
23+
### Before you open or update a pull request
24+
25+
Run the same checks used in continuous integration (see [.github/workflows/ci.yml](.github/workflows/ci.yml)):
26+
27+
1. `npm install`
28+
2. `npm run format:check`
29+
3. `npm run lint`
30+
4. `npm run build`
31+
5. `npm run test`
32+
33+
Use a **Node.js** version consistent with the `node-version` set in `ci.yml`.
34+
35+
Use clear **commit messages** (imperative subject line, optional body explaining _what_ and _why_) so history and `git bisect` stay usable.
36+
37+
### Automated tests
38+
39+
When you add or materially change behavior, include **new or updated automated tests** in the same change when practical, so CI exercises the behavior you introduce.
40+
41+
The main automated suite today is in **`packages/da-impl`**: Gherkin features and step definitions under [`packages/da-impl/test/`](packages/da-impl/test/). **`packages/common`** includes **Vitest** unit tests under [`packages/common/test/`](packages/common/test/). From the repository root, `npm run test` runs each workspace `test` script where one is defined.
42+
43+
Feature requests may include suggested test ideas in the [Feature request issue template](.github/ISSUE_TEMPLATE/Feature_request.md); bug reports may do the same in the [Bug report template](.github/ISSUE_TEMPLATE/Bug_report.md).
44+
45+
### Code style
46+
47+
Follow the repository **Prettier** and **ESLint** configuration (`format:check` and `lint` above).
48+
49+
## Reporting security issues
50+
51+
Please do not report security vulnerabilities in public GitHub issues. Follow [SECURITY.md](SECURITY.md).
52+
1753
## Governance
1854

1955
### Roles

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ To join the Electron FDC3 Desktop Agent & App Directory mailing list please emai
181181

182182
1. Fork it (<https://github.com/finos/fdc3-sail/fork>)
183183
2. Create your feature branch (`git checkout -b feature/fooBar`)
184-
3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
184+
3. Read our [contribution guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
185185
4. Commit your changes (`git commit -am 'Add some fooBar'`)
186186
5. Push to the branch (`git push origin feature/fooBar`)
187187
6. Create a new Pull Request

package-lock.json

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/common/package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
"description": "",
55
"scripts": {
66
"clean": "npx rimraf dist",
7-
"build": "tsc"
7+
"build": "tsc",
8+
"test": "vitest run"
89
},
910
"main": "dist/src/index.js",
1011
"types": "dist/src/index.d.ts",
@@ -14,7 +15,8 @@
1415
"devDependencies": {
1516
"electron": "^36.9.5",
1617
"fast-check": "^4.5.3",
17-
"rimraf": "^6.0.1"
18+
"rimraf": "^6.0.1",
19+
"vitest": "^3.2.4"
1820
},
1921
"dependencies": {
2022
"@finos/fdc3": "2.2.1-beta.3",

0 commit comments

Comments
 (0)