CONTRIBUTING.md

Welcome to Halogen!

This guide will walk you through the steps you need to take to start contributing to this repository!

This codebase is designed to be approachable. If you have a question, please ask! If you would like to try something out, open an issue and tell us about it!

First Contribution

1. First up, if you haven't already, make sure to fork this repository

This is the first step in the open source development workflow. A fork is basically your own personal copy of this repo

2. Clone the repository down to your computer

• (more details on fork and clone are in the README.md file)

3. Find an issue to work on

You can find an interactive design mockup here that will help if you choose an issue with UI elements. This is an evolving document, so if something seems off, send us a message and we'll take a look!

Navigate to the issues tab, and see if any of the current unassigned issues look like something you'd like to tackle. If one catches your eye, open it up and add a comment requesting that it gets assigned to you.

• If you're really feeling lost, but would like to get your feet wet just a little bit, go ahead and create an issue using the Beginner help template.

4. Wait to be assigned the requested issue

If you selected an issue that was not assigned to someone else and had no comments on it, you can probably safely move forward to the next steps, but if you want to be certain someone else isn't doing the same work, you should wait to be assigned, it won't take long!

5. Create a feature branch for the work you will be doing (If you need to go over forking, cloning, branching, etc, GitHub has some great guides)

git checkout -b your-cool-branch-name

6. Make code changes

console.log("You're doing it!");

7. Add the files you made changes to

git add changed-file1.html
git add changed-file2.js
git add changed-file3.css

# you can also run: git add .
# This will automatically add all the files you made changes too. 

8. Commit your code changes

git commit -m "finished my feature work"

9. Push your changes up to your feature branch

git push --set-upstream origin your-cool-branch-name

You only need --set-upstream origin branch-name the first time you push to a new branch. Subsequent pushes to that branch can just use git push.

10. Submit a pull request

Back in GitHub, navigate to your forked halogen repository, and you should see a new banner on the page that says your-cool-branch-name had recent pushes, and a button to create a PR. Go ahead and click it.

11. Naming your PR

Make sure to name your PR closes developer-delta/halogen#[issue-number].

Then in the comment section, explain the work you completed.

12. 🎉 PR Party!🎉

Now you can submit your pull request!

You should get an approval or feedback within a couple days, and then your PR will either get merged and you'll be all done, or changes will be requested via comments, and you'll make edits, then add, commit, and push your fixes.