Skip to content

Commit ef56f61

Browse files
authored
Add contributing.md (#326)
1 parent 6b817e3 commit ef56f61

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Contributing to Website Scraper
2+
3+
Thank you for considering contributing to Website Scraper! 🎉👍
4+
5+
We love contributions from everyone. :heart:
6+
7+
### Get in touch
8+
* Report bugs, suggest features, ask usage questions or view the source code on [Github](https://github.com/website-scraper/node-website-scraper)
9+
* Discuss topics on [Gitter](https://gitter.im/website-scraper/node-website-scraper)
10+
11+
### Issues
12+
If you've found a bug or have a new feature to suggest - let us know.
13+
14+
#### Reporting Bugs
15+
When you are creating a bug report, please include as many details as possible. Fill out the [required template](https://github.com/website-scraper/node-website-scraper/blob/master/.github/ISSUE_TEMPLATE.md), the information it asks for helps us resolve issues faster.
16+
17+
#### Suggesting Enhancements
18+
If you have an idea that would be nice to have, create an issue. Provide a clear and detailed explanation of the feature you want and why it's important to add.
19+
20+
### Pull requests
21+
22+
0. If you are going to work on something large or complex - please create issue for it first and wait until maintainers accept it to ensure your idea is aligned with product vision.
23+
1. In almost all of the cases your PR needs tests. Make sure you have any.
24+
2. Run `npm test` locally. Fix any errors before pushing to GitHub.
25+
3. After submitting the PR a build will be triggered on TravisCI. Wait for it to ends and make sure all jobs are passing.
26+
4. Don't forget to update documentation (README.md) if you add new option.
27+
28+
### Code of Conduct
29+
30+
All members of our community are expected to follow our [Code of Conduct](https://github.com/website-scraper/node-website-scraper/blob/master/CODE_OF_CONDUCT.md). Please make sure you are welcoming and friendly in all of our spaces.

0 commit comments

Comments
 (0)