Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.8 KB
Raw

Contributing to browserapis.wtf

Thanks for considering a contribution to browserapis.wtf ⚡!

There are many ways you can get involved with contributing here. But first, read our Code of Conduct.

How to run the website locally

  1. Fork the Repository
  2. bundle install
  3. bundle exec middleman
  4. Go to localhost:4567 in your browser 👀

Reporting an Issue

Bugs happen 🐛. If you've spotted a bug on the browsersapi.wtf website then please feel free to log it in our issue tracker, and thank you in advance 💖.

Requesting an API

If you know of an API that belongs on browserapis.wtf but aren't able to implement it yourself: submit a request to the issue tracker, where the title of the issue is the API you'd like to add. e.g. Add Ambient light API.

How to add an API

It's dangerous to go alone, take this: 🔥. These instructions will show you the basics of creating an submitting an API to this repository.

  1. Fork the Repository
  2. Create the file for the new API
    • All APIs are found in the source/browserapis folder of this repository.
    • Make a copy of example.html.md and rename it to the name of the API you want to add. e.g. ambient.html.md.
  3. Commit your changes with a succinct commit message, explaining what you have added. If your API addition is linked to a request in the issue tracker, consider adding the number of the PR to the commit message. e.g. Adds Ambient API: Closes #98.
  4. Push your changes up to your fork.
  5. Make a Pull Request for this repository.