Skip to content

Commit

Permalink
contributing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yrtimiD committed Jan 27, 2024
1 parent 174caa5 commit e549c6f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 22 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Contributing
### Local testing
Prepare `.env` file in the repo root with next content (replace <xxx> placeholders with actual values):
```
GITHUB_REPOSITORY="<OWNER/REPO>"
GITHUB_REF="refs/heads/<BRANCH>"
GITHUB_REF_NAME="<BRANCH>"
GITHUB_TOKEN="<GITHUB PAT TOKEN WITH REPO AND USERS READ PERMISSIONS>"
GITHUB_ACTION='.'
INPUT_SHA_FROM=<FROM COMMIT>
INPUT_SHA_TO=<TO COMMIT>
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.

22 changes: 0 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <xxx> placeholders with actual values):
```
GITHUB_REPOSITORY="<OWNER/REPO>"
GITHUB_REF="refs/heads/<BRANCH>"
GITHUB_REF_NAME="<BRANCH>"
GITHUB_TOKEN="<GITHUB PAT TOKEN WITH REPO AND USERS READ PERMISSIONS>"
GITHUB_ACTION='.'
INPUT_SHA_FROM=<FROM COMMIT>
INPUT_SHA_TO=<TO COMMIT>
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 )

0 comments on commit e549c6f

Please sign in to comment.