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
Thank you for your interest in contributing to `regular-table`!
4
4
5
-
`regular-table` is built on open source and hosted by the Fintech Open Source Foundation (FINOS). We invite you to participate in our community by adding and commenting on [issues](https://github.com/finos/regular-table/issues) (e.g., bug reports; new feature suggestions) or contributing code enhancements through a pull request.
6
-
7
-
Note that commits and pull requests to FINOS repositories such as `regular-table` may only be accepted from those contributors with a [Contributor License Agreement (CLA)](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Contribution+Compliance+Requirements#ContributionComplianceRequirements-ContributorLicenseAgreement) with FINOS. This may take the form of either:
8
-
* an active, executed Individual Contributor License Agreement (ICLA) with FINOS, OR
9
-
* coverage under an existing, active Corporate Contribution License Agreement (CCLA) executed with FINOS (most likely by the developer's employer). Please note that some, though not all, CCLAs require individuals/employees to be explicitly named on the CCLA.
10
-
11
-
Commits from individuals not covered under an CLA can not be merged by `regular-table`'s committers. We encourage you to check that you have a CLA in place well in advance of making your first pull request.
12
-
13
-
Need an ICLA? Unsure if you are covered under an existing CCLA? Confused? Email [help@finos.org](mailto:help@finos.org) and the foundation team will help get it sorted out for you.
14
-
15
-
If you have any general questions about contributing to `regular-table`, please feel free to open an issue on [github](https://github.com/finos/regular-table/issues/new), or email [help@finos.org](mailto:finos.org).
5
+
`regular-table` is built on open source and hosted by the Fintech Open Source
6
+
Foundation (FINOS). We invite you to participate in our community by adding and
7
+
commenting on [issues](https://github.com/finos/regular-table/issues) (e.g., bug
8
+
reports; new feature suggestions) or contributing code enhancements through a
9
+
pull request.
10
+
11
+
Note that commits and pull requests to FINOS repositories such as
12
+
`regular-table` may only be accepted from those contributors with a
- an active, executed Individual Contributor License Agreement (ICLA) with
17
+
FINOS, OR
18
+
- coverage under an existing, active Corporate Contribution License Agreement
19
+
(CCLA) executed with FINOS (most likely by the developer's employer). Please
20
+
note that some, though not all, CCLAs require individuals/employees to be
21
+
explicitly named on the CCLA.
22
+
23
+
Commits from individuals not covered under an CLA can not be merged by
24
+
`regular-table`'s committers. We encourage you to check that you have a CLA in
25
+
place well in advance of making your first pull request.
26
+
27
+
Need an ICLA? Unsure if you are covered under an existing CCLA? Confused? Email
28
+
[help@finos.org](mailto:help@finos.org) and the foundation team will help get it
29
+
sorted out for you.
30
+
31
+
If you have any general questions about contributing to `regular-table`, please
32
+
feel free to open an issue on
33
+
[github](https://github.com/finos/regular-table/issues/new), or email
34
+
[help@finos.org](mailto:finos.org).
16
35
17
36
## Guidelines
18
37
19
38
When submitting PRs to `regular-table`, please respect the following general
20
39
coding guidelines:
21
40
22
-
* Please try to keep PRs small and focused. If you find your PR touches multiple loosely related changes, it may be best to break up into multiple PRs.
23
-
* Individual commits should preferably do One Thing (tm), and have descriptive commit messages. Do not make "WIP" or other mystery commit messages.
24
-
* ... that being said, one-liners or other commits should typically be grouped. Please try to keep 'cleanup', 'formatting' or other non-functional changes to a single commit at most in your PR.
25
-
* PRs that involve moving files around the repository tree should be organized in a stand-alone commit from actual code changes.
26
-
* Please do not submit incomplete PRs or partially implemented features. Feature additions should be implemented completely. If your PR is a build, documentation, test change, or an API change that is not applicable to the UX, please explain this in the comments.
27
-
* Please do not submit PRs disabled by feature or build flag - experimental features should be kept on a branch until they are ready to be merged.
28
-
* Feature additions, make sure you have added complete JSDoc to any new APIs, as well as additions to the [Usage Guide]() if applicable.
29
-
* All PRs should be accompanied by tests asserting their behavior in any packages they modify.
30
-
* Do not commit with `--no-verify` or otherwise bypass commit hooks, and please respect the formatting and linting guidelines they enforce.
31
-
* Do not `merge master` upstream changes into your PR. If your change has conflicts with the `master` branch, please pull master into your fork's master, then rebase.
41
+
- Please try to keep PRs small and focused. If you find your PR touches
42
+
multiple loosely related changes, it may be best to break up into multiple
43
+
PRs.
44
+
- Individual commits should preferably do One Thing (tm), and have descriptive
45
+
commit messages. Do not make "WIP" or other mystery commit messages.
46
+
- ... that being said, one-liners or other commits should typically be
47
+
grouped. Please try to keep 'cleanup', 'formatting' or other non-functional
48
+
changes to a single commit at most in your PR.
49
+
- PRs that involve moving files around the repository tree should be organized
50
+
in a stand-alone commit from actual code changes.
51
+
- Please do not submit incomplete PRs or partially implemented features.
52
+
Feature additions should be implemented completely. If your PR is a build,
53
+
documentation, test change, or an API change that is not applicable to the
54
+
UX, please explain this in the comments.
55
+
- Please do not submit PRs disabled by feature or build flag - experimental
56
+
features should be kept on a branch until they are ready to be merged.
57
+
- Feature additions, make sure you have added complete JSDoc to any new APIs,
58
+
as well as additions to the [Usage Guide]() if applicable.
59
+
- All PRs should be accompanied by tests asserting their behavior in any
60
+
packages they modify.
61
+
- Do not commit with `--no-verify` or otherwise bypass commit hooks, and
62
+
please respect the formatting and linting guidelines they enforce.
63
+
- Do not `merge master` upstream changes into your PR. If your change has
64
+
conflicts with the `master` branch, please pull master into your fork's
65
+
master, then rebase.
32
66
33
67
## Contribution Process
34
68
35
69
Before making a contribution, please take the following steps:
36
-
1. Check whether there's already an open issue related to your proposed contribution. If there is, join the discussion and propose your contribution there.
37
-
2. If there isn't already a relevant issue, create one, describing your contribution and the problem you're trying to solve.
38
-
3. Respond to any questions or suggestions raised in the issue by other developers.
70
+
71
+
1. Check whether there's already an open issue related to your proposed
72
+
contribution. If there is, join the discussion and propose your contribution
73
+
there.
74
+
2. If there isn't already a relevant issue, create one, describing your
75
+
contribution and the problem you're trying to solve.
76
+
3. Respond to any questions or suggestions raised in the issue by other
77
+
developers.
39
78
4. Fork the project repository and prepare your proposed contribution.
40
79
5. Submit a pull request.
41
80
42
-
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://community.finos.org/docs/governance/Software-Projects/contribution-compliance-requirements) and submit (or have your employer submit) the required CLA before submitting a pull request.
43
-
81
+
NOTE: All contributors must have a contributor license agreement (CLA) on file
82
+
with FINOS before their pull requests will be merged. Please review the FINOS
1. For the duration of building declarations, temporarily `export` the
76
-
`RegularTableElement` in `src/js/index.js`:
119
+
`RegularTableElement` in `src/js/index.js`:
77
120
78
121
```javascript
79
122
// TEMP: export keyword added for building declarations
@@ -83,7 +126,7 @@ export class RegularTableElement extends RegularViewEventModel {
83
126
2. Run typescript declarations build:
84
127
85
128
```bash
86
-
yarn declarations
129
+
pnpm run declarations
87
130
```
88
131
89
132
This will create `declarations/index.d.ts` and other typescript
@@ -102,5 +145,7 @@ with the contents of the just-built `declarations/index.d.ts`.
102
145
103
146
### Troubleshooting
104
147
105
-
If an update to index.d.ts is found to break the compilation of any downstream projects, a likely place to check for errors are the pure jsdoc typedefs in `src/js/index.js` below the RegularTableElement class defintion. Ensure that all of the described types are in sync with their current javascript counterparts.
106
-
148
+
If an update to index.d.ts is found to break the compilation of any downstream
149
+
projects, a likely place to check for errors are the pure jsdoc typedefs in
150
+
`src/js/index.js` below the RegularTableElement class defintion. Ensure that all
151
+
of the described types are in sync with their current javascript counterparts.
0 commit comments