alihan/headless-recorder
1
0
Fork 0
mirror of https://github.com/checkly/headless-recorder.git synced 2021-07-28 02:03:42 +03:00
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Tim Nolet
2018-10-06 02:51:23 +02:00
committed by GitHub
parent bfde603c24
commit 7274814739
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@@ -1,9 +1,15 @@
# Contributing
Thanks you for your interest in Puppeteer Recorder! We'd love to accept your patches and contributions, but please remember that this project
was started first an foremost to serve the users of the Checkly API and Site transaction monitoring service.
HI! Thanks you for your interest in Puppeteer Recorder! We'd love to accept your patches and contributions, but please remember that this project was started first and foremost to serve the users of the Checkly API and Site transaction monitoring service.
## Getting setup
## New feature guidelines
When authoring new features or extending existing ones, consider the following:
- All new features should be accompanied first with a Github issues describing the feature and its necessity.
- We aim for simplicity. Too many options, buttons, panels etc. detract from that.
- Features should serve the general public. Very specific things for your use case are frowned upon.
## Getting set up
1. Clone this repository
@@ -37,14 +43,6 @@ To run code linter, use:
```bash
npm run lint
```
## Feature guidelines
When authoring new features methods, consider the following:
- All new features should be accompanied first with a Github issues describing the feature and its necessity.
- We aim for simplicity. Too many options, buttons, panel etc. detract from that.
- Features should serve the general public. Very specific things for your usecase only are not that.
## Commit Messages
Commit messages should follow the Semantic Commit Messages format: