Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 1.78 KB
Raw

Contributing to Quick Menu

Thank you firstly for your willingness to contribute to the Quick Menu project, as it was originally developed independently and released open source in an effort to improve mobile navigation on the World Wide Web. We appreciate your participation in this project.

Setting up Locally

  1. Using the command line, clone the repository and cd into the directory.
  2. Ensuring you have Node.js and NPM installed, run npm install.
  3. To have NPM watch for changes and compile automatically, run npm run watch.
  4. Once complete with your development, run npm run build to compile and generate all the dist files.

To visualise the changes you're making to the Quick Menu, you should load the Local Module as a Dependency for another project (e.g. a blank project). "Local Module" in this case referring to this repository you just cloned.

Create a Pull Request

  1. Clone and fork the repository, ensuring you have the latest changes.
  2. Create a new branch from main, with a topic branch name.
  3. Once you're complete with your development, make a pull request to the main branch with an explanatory title and description. If your pull request targets an existing issue from the Issue Tracker, please add a reference to it.

Bugs and Feature Requests

If you have noticed an issue/bug or would desire for a new feature to be introduced, using the Issue Tracker please create a new issue and apply an appropriate label.

License

By contributing to this project you agree to release any form of work provided under the MIT License.