So you want to help us build this project up? Amazing and thanks in advance! Don't worry, you don't necessarily need to know how to code to help. Here are ways in which you can contribute to this project:
Submitting Bug Reports
Before submitting a bug report please read through the existing open and closed bug reports to ensure this bug has not been reported or fixed before. If you can't find any report of it there then please try to explicitely describe a reproducible way of arriving at this bug. You can do this by submitting:
- Smallest possible bit of code that leads to this bug
- Any error messages
- Pictures of cats to make maintainers feel better about the fuss they have cause you
Suggesting Enhancements
Before suggesting an enhancement please read through the existing open and closed feature requests to ensure this bufeatureg has not been proposed before or even already implemented!
Your First Code Contribution
Unsure where to begin contributing to Spider-Core? You can start by looking through these beginner and help-wanted issues:
- Beginner issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than beginner issues.
Do check the local development section of these tutorials in case you haven't really used NodeJS much before or aren't too familiar with Eslint or JSDoc.
Pull Requests
The process described here has several goals:
- Maintain Spider-Core's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Spider-Core
- Enable a sustainable system for Spider-Core's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.