You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- 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.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+36Lines changed: 36 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
3
3
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).
Before making a contribution, please take the following steps:
@@ -14,6 +16,40 @@ Before making a contribution, please take the following steps:
14
16
15
17
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.
16
18
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).
0 commit comments