Thank you for considering contributing to Website Scraper! 🎉👍
We love contributions from everyone. ❤️
If you've found a bug or have a new feature to suggest - let us know.
When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
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.
- 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.
- In almost all of the cases your PR needs tests. Make sure you have any.
- Run
npm test
locally. Fix any errors before pushing to GitHub. - After submitting the PR a build will be triggered on TravisCI. Wait for it to ends and make sure all jobs are passing.
- Don't forget to update documentation (README.md) if you add new option.
All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.