2021-03-14 19:19:42 +01:00
|
|
|
# FaceAPI Library: Contributing Guidelines
|
|
|
|
|
|
2021-03-18 11:34:38 +01:00
|
|
|
Pull requests from everyone are welcome
|
|
|
|
|
|
|
|
|
|
Procedure for contributing:
|
|
|
|
|
|
|
|
|
|
- Create a fork of the repository on github
|
|
|
|
|
In a top right corner of a GitHub, select "Fork"
|
|
|
|
|
- Clone your forked repository to your local system
|
|
|
|
|
`git clone https://github.com/<your-username>/<your-fork>
|
|
|
|
|
- Make your changes
|
|
|
|
|
- Test your changes against code guidelines
|
|
|
|
|
`npm run lint`
|
|
|
|
|
- Push changes to your fork
|
|
|
|
|
- Submit a PR (pull request) to `FaceAPI`
|
|
|
|
|
<https://github.com/vladmandic/face-api/pulls>
|
|
|
|
|
|
|
|
|
|
Your pull request will be reviewed and pending review results, merged into main branch
|
