Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

29 lines (21 loc) · 1.12 KB
Raw

Local Setup

  • Fork the Project
  • Clone the Repository: git clone https://github.com/<YOUR-USERNAME>/nyaa-linker.git
  • Install Dependencies: yarn
  • Create a Feature Branch: git checkout -b feature/feature-name or git checkout -b fix/problem-name

Test Changes

Firefox: about:debugging#/runtime/this-firefox

  • rename manifest-firefox.json to manifest.json
  • click on the Load Temporary Add-on... button
  • select the manifest.json file

Chrome: chrome://extensions/

  • rename manifest-chrome.json to manifest.json
  • click on the Load unpacked button
  • select the src folder

Submit Changes

  • Stage changes: git add .
  • Commit changes: git commit -m "add: Feature Name" or git commit -m "fix: Problem Name"
    • for simple documentation changes, use Github's default "Update file.name"
  • Push changes: git push origin feature/feature-name or git push origin head
  • Submit a Pull Request on Github: if your Feature resolves an Issue, add fix #XXX in the description