Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.86 KB

Contributing to Open Source Club Website

Thank you for helping out with the OSC's club website!

Following these guidelines helps us keep good project workflow. We appreciate you working with us on it.

Please read our CODE_OF_CONDUCT.md to understand our community expectations. Check out our Discord for any additional questions or just to hangout! Look at our CONTRIBUTORS.md for a list of maintainers and contributors.

How to help?

Please check the Projects and Issues pages for current task. If you see something that you would like to help with, ask about helping in a comment and we'll assign it too you. If you're just starting out, checkout our beginner friendly issues for ways to help.

Checkout the DESIGN.md file for a high level explanation of the project. Check out the other files in docs for more information.

Report Bug

Check to see if someone already reported this bug already exists. If so then leave a comment on that issue. If not, please provide a detailed description of the bug. Include what was happening before the error, all settings, and test results. This helps us more quickly identify and solve any problems. Create an Issue with the description and add a bug label. We will do our best to respond quickly to it.

Request a Feature

If it's not already an issue, describe the feature and why it would be beneficial. Create an Issue with this description and add a feature enhancement label. We will do our best to respond quickly to it.

Run Test

Open it up in a browser.

Submit Changes

  1. Create a fork or branch to tackle a specific issue
    • Team members branch off of dev and follow this guide
    • Others make a fork
  • Name it after the issue or feature you are working on
  1. Follow the style guidelines below
    • This helps with debugging and working on the project
  2. Make small incremental commits
    • It's easier to find issues when only a small amount of code is changed
  3. Verify everything works (and that nothing broke)
  4. Make a pull request
    • The request will be reviewed
    • Any needed changes will be noted
  5. The changes will be added to the project
    • Yay! Thank you so much for helping out

Style Guide

OSC general style guidelines