Skip to content

Latest commit

 

History

History
120 lines (75 loc) · 3.38 KB

README.md

File metadata and controls

120 lines (75 loc) · 3.38 KB
Raw

How to contribute

Contributing procedure

Submit an issue

  • Create a new issue
  • Comment on the issue (if you'd like to be assigned to it) - that way the issue can be assigned to you.

Open issues

  • Go to open issues
  • select an issue of your choice that is open or need help or is up-for-grabs and is not assigned.
  • Comment on the issue (if you'd like to be assigned to it) - that way the issue can be assigned to you.

Fork the repository (repo)

Set up your local environment (optional)

If you're ready to contribute and create your PR, it will help to set up a local environment so you can see your changes.

  1. Set up your development environment

    • install your favorite text editor/IDE
    • install Nodejs

  2. Clone your fork

If this is your first time forking our repo, this is all you need to do for this step:

$ git clone [email protected]:[your_github_handle]/e-citizen-lh.git && cd e-citizen-lh

Make sure you checkout the develop branch git checkout develop

If you've already forked the repo, you'll want to ensure your fork is configured and that it's up to date. This will save you the headache of potential merge conflicts.

To configure your fork:

$ git remote add upstream https://github.com/Luna-Hacks-2-0/e-citizen-lh.git

To sync your fork with the latest changes:

$ git checkout develop
$ git fetch upstream
$ git merge upstream/develop
  1. Install dependencies
$ yarn install

or

$ npm install

Make awesome changes!


  1. Create new branch for your changes
$ git checkout -b new_branch_name
  1. start development server
$ yarn run dev

or

npm run dev

Start developing!


  • Open this directory in your favorite text editor / IDE, and see your changes live by visiting localhost:3000 from your browser
  • Pro Tip: Explore scripts within package.json for more build options
  1. Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see how to link a commit message to an issue using a keyword.
$ git commit -m "brief description of changes [Fixes #1234]"
  1. Push to your GitHub account
$ git push

Submit your Pull Request (PR)🚀

  • After your changes are commited to your GitHub fork, submit a pull request (PR) to the develop branch of the Luna-Hacks-2-0/e-citizen-lh repo
  • In your PR description, reference the issue it resolves (see linking a pull request to an issue using a keyword)
  • For features commit with the following nameing convention feature\[name of feature]
    • ex. Updates out of date content [Fixes #1234]