CONTRIBUTING.md

Contributing to Club Resources

Thank you for helping out with the Open Source Clubs's Resources!

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!

How to help?

Please check the Issues page for current tasks. 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.

Request a Feature

Check to see if the feature is already an [Issue][Issue] . If it's not, 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.

Submit Changes

1. Create a fork or branch of dev to tackle a specific issue
   • Team members branch off of dev and follow this guide
     • You can become a team member through our Discord
   • Others make a fork

• Name it after the issue or feature you are working on

2. Follow the style guidelines below
   • This helps with debugging and working on the project
3. Make small incremental commits
   • It's easier to find issues when only a small amount of code is changed
4. Run and pass tests
   • Some of our larger projects use Travis for Continuous Integration (CI).
5. Make a pull request
   • The request will be reviewed
     • If there is not a response after a few days, try contacting the project lead
   • Any needed changes will be noted
6. The changes will be added to the project
   • Yay! Thank you so much for helping out

Style Guide

Use our .editorconfig to help automatically format your code.

For a more descriptive list, check out our club's markdown style guidelines.