Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 3.32 KB
Raw

Contributing to Project Name

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

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][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][Beginner Issues] issues for ways to help.

Checkout the DESIGN.md file for a high level explanation of the project. For a road map, look at the TODO.md which lists planned features for the project. Check out the other files in docs for more information.

Report Bug

Check to see if someone already reported this [bug][Bug Issues] 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][Issues] with the description and add a bug label. We will do our best to respond quickly to it.

Request a Feature

Check to see if the feature is already listed in our TODO.md. If it's not, describe the feature and why it would be beneficial. Create an [Issue][Issues] with this description and add a feature enhancement label. We will do our best to respond quickly to it.

Run Test

Give detailed instructions on how to run the test. Also include information about the meaning of the results.

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. Run and pass tests
  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

Use our .editorconfig to help automatically format your code. A short list of what we require.

  • Use descriptive names for everything
  • Make meaningful comments often
  • Indent with tabs, use spaces everywhere else
  • Put curly braces on a new line
  • Keep line length under 100 characters

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

Example

**A short style example**

[Beginner Issues]: [Bug Issues]: