Skip to content
This repository has been archived by the owner on Dec 17, 2023. It is now read-only.

Latest commit

 

History

History
56 lines (37 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.78 KB
Raw

How to Contribute

This project has issues that are organized on this github project board. There are 2 ways you could contribute to this project;

Design Contribution

We are currently working with on figma designs for this website that are being translated into the code. Most of the Design contributions are made on request to access the file. Issues that are related to Designing the UI/UX will be labelled with the design label in the issues tab.

NB: _Unless otherwise, all Frontend UI/UX visual modifications and new features should align with the figma design. Also, all assets (anything that is no-code and is a resource), should be under the assets folder

Code Contribution

This website Frontend is built using react framework and Frontend logic (for authentication and API connection) is built using the redux logic.

Project Structure

Running project locally

To get your local instance up and running. ensure that you have node and npm installed on your local machine. if not, check out this digitalocean robust tutorial depending on what operating system you are using.

  1. Fork and clone this project on your local machine.

    https://github.com/<YOUR_USERNAME>/badging-website.git

  2. In your project folder, install packages by running

    cd badging-website
npm install

  3. Create a new branch for your changes with a meaningful name from your updated origin/main branch. If you are not sure how to name your branch, refer to Jefferderman's post on branch naming.
    To create a new branch, type;

    ```sh
git checkout -b branch-name
```

  4. To run the project locally on your machine and test out your changes in real-time, run the following command.

    npm run dev
# runs your the website locally on http://localhost:5050/

  5. Commit the change(s) and create a Pull Request. Make sure your commits are signed. If you are unsure how to sign commits, check out this condensed summary on how to sign commits.
    Any pull requests containing commits that are not signed off will not be eligible for merge until the commits have been signed off.
    To commit your changes and push them, type the following commands;

    ```sh
git add .
git commit -S -m "my changes"
git push -u origin branch-name
```