Skip to content

Latest commit

 

History

History
147 lines (87 loc) · 6.11 KB

CONTRIBUTING.md

File metadata and controls

147 lines (87 loc) · 6.11 KB
Raw

Contributing to BwJobForGraduates

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to BW Jobs For Graduates.These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

I don't want to read this whole thing, I just have a question!!!

What should I know before I get started?

How Can I Contribute?

Styleguides

Code of Conduct

This project and everyone participating in it is to be respectful to other contributors regardless for their coding level or editor theme (light / dark).

I don't want to read this whole thing I just have a question!!!

Note: Please don't file an issue to ask a question. We will create a chat channel for your kind.

What should I know before I get started?

BwJobForBotswana is an NGO whoes sole purpose is to provide employment oppotunites for Botswana graduates.

Design Decisions

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

  • Check to see if it has not already been reported

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues.

Suggesting Enhancements

We are only human, we might have overlooked amazing features. So we are always open to hearing what you think could making BwJobForBotswana AMAZING.

Before Submitting An Enhancement Suggestion

  • Check to see if it has not already been suggested this helps us focus and not waste time on duplicates

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. IF you you wish to suggest enhancements provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs if possible.
  • Explain why this enhancement would be useful

Your First Code Contribution

Simply find an issue you are know you can handle and comment requesting assignment to avoid working on an issue already being solved by someone else.

  • [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
  • [Help wanted issues][help-wanted] - issues which should be a bit more involved than beginner issues.

Pull Requests

Please follow these steps to have your contribution considered by the maintainers:

  1. Provide picture/link of feature added ("saves our hairlines" and "is likely to be merged faster")
  2. PLEASE MAKE ALL PULL REQUESTS TO THE DEVELOP BRANCH
  3. Follow the styleguides
  4. After you submit your pull request, verify that all status checks are passing
    What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

Styleguides

Git Commit Messages

  • Be short but cover important parts ("like a mini skirt")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • When only changing documentation, include [ci skip] in the commit title
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

  • Inline exports with expressions whenever possible 
    // Use this:
export default class ClassName {

}

// Instead of:
class ClassName {

}
export default ClassName