Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.7 KB
Raw

Contributing to KeyKorea

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use GitHub Flow, So All Code Changes To The Main Branch Happen Through Pull Requests

  1. Update your local repo with git pull origin main,
  2. Create a working branch with git checkout -b MyNewBranch
  3. Make your changes on your branch and stage them with git add .
  4. Commit your changes locally with git commit -m "description of your commit"
  5. Upload the changes (including your new branch) to GitHub with git push origin MyNewBranch
  6. Go to the main repo on GitHub where you should now see your new branch
  7. Click on your branch name
  8. Click on “Pull Request” button
  9. Click on “Send Pull Request”

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue

Use a Consistent Coding Style

For the client JavaScript code

  • Use the Prettier Code Automatter.
  • With Prettier, everytime you save a JavaScript file it will be autoformatted acccording to the rules set in the .prettierrc file inside the client directory, ensuring that all JavaScript files are formatted the same way
  • Instructions to setup Prettier with VSCode can be found here

References

This document was adapted from https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62 and the instructional steps for collaborating are adapted from https://uoftcoders.github.io/studyGroup/lessons/git/collaboration/lesson/