Skip to content
This repository has been archived by the owner on Apr 10, 2022. It is now read-only.

Latest commit

 

History

History
66 lines (56 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

66 lines (56 loc) · 3.33 KB

Contributing

Thank you for your interest in helping with the development and maintenance of FSU's ACM Website! Please check the issues page for current tasks to assist on. If you are interested in addressing an active issue, leave a comment on it so that we can assign it to you.

Request an Enhancement

If there are additions to the site that you'd like to see, open up an issue describing the feature and how it may be benefical to add. Please make sure to correctly label the issue and to double check that it does not already exist.

Report a Bug

Prior to reporting a bug, please make sure there is not already an active issue of this bug. When submitting a new bug, please make sure to be as descriptive as possible (what string of events happened leading up to the fault, what environment/browser you are using, what type of device you are using, etc.) to better help us understand the situation and address it more quickly.

Testing

  1. Run git clone https://github.com/FSU-ACM/homepage-v2.git in your local repository
  2. Drag and drop the src/html/index.html file in your browser of choice.

Making Changes

  1. Fork the master branch 
    # for the master branch and clone your forked copy
git clone https://github.com/<YourGitHubUsername>/homepage-v2.git
  • If you anticipate spending considerable amount of time on a change, make sure you keep your local repository up to date 
    # add upstream repository to remotes
git remote add upstream https://github.com/FSU-ACM/homepage-v2.git

# verify that the upstream repository was added
git remote -v
  • Whenever you want to update your fork, you will need to fetch from the upstream repository to bring its updated branches and commits 
    # fetch from upstream
git fetch upstream

# checkout your master branch and merge upstream's master branch
git checkout master
git merge upstream/master
  • If there are unique changes to your local master branch, you may have to deal with conflicts. Follow the next section to avoid this.
  1. Create a branch for the feature you'd like to add/work 
    # make sure you are on master branch
git checkout master

# choose a simple name that describes the feature for new branch name
git branch feature_name

# checkout your new branch
# git checkout -b feature_name combines this and the last command
git checkout feature_name
  2. Submit your pull request
  • In the case of new commits to the upstream master, you will want to rebase your local master branch to avoid any future conflict resolution work 
    # fetch upstream and merge
git fetch upstream
git checkout master
git merge upstream/master

# if any new commits, rebase development branch
git checkout feature_name
git rebase master
  • Now all there is left to do is open your forked repository on GitHub, use the dropdown list to select your development branch (feature_name), and click the pull request button.

Resources