Skip to content

Files

Latest commit

SoitoraSoitora
Tweak README, add CoC, and Contributor guide
Apr 17, 2021
70b31b8 · Apr 17, 2021

History

History
87 lines (51 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

87 lines (51 loc) · 2.91 KB

Paperback Website Contributing Guide

Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

Development Setup

You will need Node.js version 12+, and npm version 7+.

After cloning the repo, run:

# Installs any dependencies needed.
$ npm install

To run the project now, run:

# This command start a local server you can access and edit live.
$ npm run serve

Commonly used NPM scripts

# This command will generate a static site inside a public directory in your project.
$ npm run build

# This command will lint your files.
$ npm run lint

Please make sure to have npm run build pass successfully before submitting a PR. Although the same tests will be run against your PR on the CI server, it is better to have it working locally.

Project Structure

  • public: contains built files for distribution. Note this directory is only updated when a release happens or when you run the build command. Changes to this folder will not carry over with Git.

  • src: contains the main code files.

    • .vuepress: contains the main code files.

      • components: this contains all the .vue components used on the website.

      • config: contains complementary files for config.js.

        • nav: contains files for the navigation config.

        • sidebar: contains files for the sidebar config.

        • plugins.js: config for plugins.

      • public: contains the static images/videos/scripts you'll want to use for the website.

      • styles: all the projects style files are contained here.

      • config.js: main config file for Vuepress.

      • enhanceApp.js: this file is the place to install Vue plugins, register components and directives, etc.

    • addRepo: contains the markdown file for the /addRepo/ page.

    • help: contains the markdown files for all the /help/... pages.

    • tools: contains the markdown files for the /tools/... pages.

    • uwu: contains the markdown files for the /uwu/... pages.

    • ?lang?: contains the markdown files for the specified languages pages.

    • privacy_policy.md: markdown file for the privacy policy.

    • README.md: markdown file for the front-page.

  • package.json: contains information about which plugins are installed in the project.

Credits

Thank you to all the people who have already contributed!