Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 950 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 950 Bytes

Contributing Guidelines

Adding Websites

  1. Fork this repository
  2. Navigate to ./src/directory/ and add your site as a new *.md file. Use existing sites as a reference in terms of required information
  3. Optional: Add your own web button (88x31) in ./src/static/img/directory; reference your button in your *.md file using its filename for the button front matter property
  4. Open a pull request for your changes

Front Matter Data

Add your website's data in your *.md file using the following properties:

  • title: Name your website / required
  • url: Your website's URL / required
  • author: Name yourself / optional
  • button: File name of a button for your listing / optional

Development

  1. Fork this repository
  2. Use npm install on your machine
  3. Use npm run serve to start a local web server at localhost:8080
  4. Make changes
  5. Test your changes
  6. Open a pull request with your changes