Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.88 KB
Raw

CONTRIBUTING

All contributions are welcome!

If you'd like to submit a change, please create a Pull-Request. There are some issues in the repository you can base you're contribution on.

Don't forget to add yourself as a contributor to the project README section!

Creating a PR

  1. Fork this repo
  2. Clone your forked version
  3. Make and commit your awesome contribution change
  4. Push commits to your forked repo
  5. Come back to your repo (the forked one)
  6. Open the Pull-Request tab and create the PR!

Often the original repo (uspcodelab/handbook) is updated and there's the need to update your fork too. In that case, you need to add a new remote to your repo. In your computer, do:

  1. Add the original remote git remote add fork-origin [email protected]:uspcodelab/handbook
  2. Fetch updates from it git fetch fork-origin
  3. Rebase your master git rebase fork-origin/master master
  4. Update your remote git push origin master

If you already have the original remote added, then just follow steps 2 to 4.

Project Structure

We follow the directory structure recommended here! Therefore, in order to have your PR approved faster, always double check whether or not your changes respect the directory structure.

  • docs: root directory for this VuePress project. All files related to USPCodeLab's handbook are present in this directory. In order to add content, change project configurations, update themes, it'll all be done here :)
    • .vuepress: directory that stores global configuration, components, static resources, etc.
      • .vuepress/config.js: configuration file. You can see the configuration options here.
    • docs/README.md: content for handbook's index page.