CONTRIBUTING.md

Contributing to w3c-link-validator

🎉 Great to see your interested in contributing! 🎉

The following guidelines are set out for contributing to w3c-link-validator, please read through carefully

Table of Contents

Code of Conduct

Getting Started

• How it works (crawling algorithm)
• Development Setup

Found a bug?

Submitting an Issue

• Reporting Bugs
• Suggesting Ehancements
• Code Contribution
  • Beginner Issues

Styleguides

• Git Commit Message
• JavaScript Styleguide
• Ruleset Styleguide

Attributions

License

Code of Conduct

This project and everyone participating in it is govered by our Code of Conduct. By participating, you are expected to upload this code. Please report unacceptable behavior to [email protected].

Getting Started

Coming soon

How it works (crawling algorithm)

Development Setup

Fork and clone repo

$ git clone https://github.com/<username>/w3c-link-validator.git

Install dependencies

$ npm install

Link to global commands

$ npm link

Run the tests

$ npm run test

Check the code coverage with istanbul. HTML report will be generated to /coverage/lcov-report

$ npm run coverage

Found a bug?

Ensure the bug has not already been reported by searching on GitHub under Issues

Unable to find a issue addressing the problem? Open a new one and follow steps below and template provided.

Submitting an Issue

Coming Soon

Reporting Bugs 👾

Coming Soon

Suggesting Enhancements 💡

Coming Soon

Code Contribution

Coming Soon

Beginner Issues

Coming Soon

Attributions

These contribution guidelines have been adapted from the Atom editor contribution guidelines.

License

MIT © 99XT