Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 2.61 KB

How to contribute

The gist of it is:

  1. You will make your changes in your own fork (copy) of the repository.
  2. You will make a pull request to add the changes in your fork to the base repository.
  3. Your peers will review your code and I will merge your changes when we are ready!

On commit messages

Many developers use a commit message convention called "Conventional Commits." For this repository, just make sure your message is brief and clear. Same with pull request messages. It may feel redundant with your commit messages, but remember that when you are contributing to more complicated codebases, other developers may not have as clear a context for what you are adding (whereas we are all sitting in a workshop doing the same thing!).

Step-by-step guide

  1. Fork the base repository. image image

  2. Find the folder with your name and open it. image

  3. Upload your glitch art samples to your folder and commit changes. image image

  4. In your folder, add your Hydra code to a new file called hydra.js and commit changes. image

  5. Update the README.md file in your folder with some information about your work (INCLUDING image attributions for glitch art) and commit changes. image

  6. Navigate to the "Pull requests" tab and hit "New pull request." image

  7. Review your changes and hit "Create pull request" to open the pull request template. image

  8. Write a short message about what you did and hit "Create pull request" again. image

  9. And that's it!!! You can now take a look at and comment on your peers' work under the "Pull requests" tab.