diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..de175e0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +## Contributing +### Local testing +Prepare `.env` file in the repo root with next content (replace placeholders with actual values): +``` +GITHUB_REPOSITORY="" +GITHUB_REF="refs/heads/" +GITHUB_REF_NAME="" +GITHUB_TOKEN="" +GITHUB_ACTION='.' +INPUT_SHA_FROM= +INPUT_SHA_TO= +INPUT_CODEWATCHERS=".github/CODEWATCHERS" +INPUT_IGNORE_OWN=false +``` + +Before first run `npm install`, and then `npm test` + + +### Build and Commit +Ensure to run `npm run build` before commit to update `dist` folder. + diff --git a/README.md b/README.md index 5f03a8f..4f30d69 100644 --- a/README.md +++ b/README.md @@ -79,27 +79,5 @@ Simplified version of output looks next (there are more fields): ## Usage Example See full example workflow in [examples](examples/) -## Contribution -### Local testing -Prepare `.env` file in the repo root with next content (replace placeholders with actual values): -``` -GITHUB_REPOSITORY="" -GITHUB_REF="refs/heads/" -GITHUB_REF_NAME="" -GITHUB_TOKEN="" -GITHUB_ACTION='.' -INPUT_SHA_FROM= -INPUT_SHA_TO= -INPUT_CODEWATCHERS=".github/CODEWATCHERS" -INPUT_IGNORE_OWN=false -``` - -Before first run `npm install`, and then `npm test` - - -### Build and Commit -Ensure to run `npm run build` before commit to update `dist` folder. - - ## Known limitations * Only up to 3000 files from each commit can be matched (Limitation of [Get a commit](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#get-a-commit) GitHub API )