Skip to content

Commit a5c06e3

Browse files
update readme and contributing document with building instructions
1 parent 02d6163 commit a5c06e3

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ documentation, we greatly value feedback and contributions from our community.
66
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
77
information to effectively respond to your bug report or contribution.
88

9+
## Building the Entrypoint File
10+
11+
The file that Github reads is `lib/index.js`. This is an autogenerated file built from the files found in `src`. To build the entrypoint file, run `npm run build` after all changes in `src` have been made.
12+
913

1014
## Reporting Bugs/Feature Requests
1115

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,11 @@ jobs:
7777
excluded-expressions: "[ TypeScript | Java | Python ]"
7878
```
7979
80+
81+
## Contributing
82+
83+
We welcome community contributions and pull requests. See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to contribute to this project
84+
8085
## Security
8186
8287
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

0 commit comments

Comments
 (0)