Skip to content

CONTRIBUTE.md

Latest commit

 

History

History
150 lines (105 loc) · 5.1 KB

CONTRIBUTE.md

File metadata and controls

150 lines (105 loc) · 5.1 KB

Contributing to Need4Deed's frontpage

We are lucky to have you! 🎉👍

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

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through good-first-issue labeled issues

First Merge Request

Step 1: Fork the Repository

  1. Go to the our repository: https://github.com/need4deed-org/website.
  2. Click the Fork button in the top-right corner.
  3. Choose where to fork the repository (usually your own GitHub account).

Step 2: Clone Your Forked Repository

  1. Go to your forked repository (e.g., https://github.com/your-username/website).

  2. Click the Clone button and copy it e.g. with HTTPS URL.

    git clone git@github.com:need4deed-org/website.git

  3. Navigate into the cloned repository:

    cd website

Step 3: Add the Original Repository as a Remote

  1. Add the original repository as a remote called upstream:

    git remote add upstream https://github.com/need4deed-org/website.git

  2. Verify the remotes:

    git remote -v

    You should see:

    • origin → Your forked repository.
    • upstream → The original repository.

  3. Create a new branch for your changes:

    git checkout -b your-branch-name

    The branch should titled be issue#-your_nick-feature-title, like 123-johndoe-update-readme

Step 4: Commit and Push Your Changes

  1. Stage your changes: 
    git add .
  2. Commit your changes - as in the git commit message section 
    git commit -m "Your commit message"
  3. Push your changes to your forked repository: 
    git push origin your-branch-name

Step 5: Create a pull request (PR)

  1. Go to your forked repository on GitHub: https://github.com/your-username/website.
  2. Click on Pull requests in the left sidebar.
  3. Click New pull request.
  4. Select your branch (your-branch-name) on the right and make sure develop is on the left.
  5. Click Create pull request.
  6. Fill in the Pull Request template
  7. Click Create pull request.
  8. Let us know about the awaiting review!

Reporting Bugs

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Before Submitting A Bug Report

How Do I Submit A Bug Report?

Bugs are tracked as GitHub issues. Create a bug issue. All the necessary info should be in the bug template.

Suggesting features

Feature suggestions are also tracked as GitHub issues. Please refer to the feature template.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests can be placed after the first line
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files

Please keep commits reasonably scoped, e.g. a single commit containing all the diffs is hard to comprehend.

JavaScript Styleguide

Please refer to the linter.

License

By contributing, you agree that your contributions will be licensed under its Commons Clause + MIT License.

Questions?

Don't hesitate to reach out if you have any questions! You can:

Any contributions are welcome! 🙏