Skip to content

Latest commit

 

History

History
140 lines (93 loc) · 5.54 KB

CONTRIBUTING.md

File metadata and controls

140 lines (93 loc) · 5.54 KB

Contributing Guidelines

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.

Color Codes 🎨

Native Color:

  1. #FFFFFF #FFFFFF Native White
  2. #00253A #00253A Native White

Light Mode:

  1. #0093ED #0093ED Light/Primary
  2. #0072B1 #0072B1 Light/10
  3. #7DD8FF #7DD8FF Light/20
  4. #D6F5FF #D6F5FF Light/30

Dark Mode:

  1. #03A4FF #03A4FF Dark/Primary
  2. #52C1FF #52C1FF Dark/10
  3. #044468 #044468 Dark/20
  4. #00314D #00314D Dark/30

Need some help regarding the basics?🤔

Getting started with CSS

  • We have used CSS instead of CSS
  • Do styling changes in the respective Sass file.
  • If you are facing any difficulties you can refer to this documentation.

You can refer to the following articles on the basics of Git and GitHub and also contact the Project Mentors, in case you are stuck:

Submitting Contributions👩‍💻👨‍💻

Below you will find the process and workflow used to review and merge your changes.

Step 0 : Find an issue

  • Take a look at the Existing Issues or create your own Issues!
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Note : Every change in this project should/must have an associated issue.

Issue

Step 1 : Fork the Project

  • Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.
git clone https://github.com/<your-username>/<repo-name>  
cd <repo-name>  
git remote add upstream https://github.com/<upstream-owner>/<repo-name>

Fork

  • If you have already forked the project, update your copy before working.
git remote update
git checkout <branch-name>
git rebase upstream/<branch-name>

Step 2 : Branch

Create a new branch. Use its name to identify the issue you addressing.

# It will create a new branch with name Branch_Name and switch to that branch 
git checkout -b branch_name

Step 3 : Work on the issue assigned

  • Work on the issue(s) assigned to you.
  • Add all the files/folders needed.
  • After you've made changes or made your contribution to the project add changes to the branch you've just created by:
# To add all new files to branch Branch_Name  
git add .  

# To add only a few files to Branch_Name
git add <some files>

Step 4 : Commit

  • To commit give a descriptive message for the convenience of the reviewer by:
# This message get associated with all files you have changed  
git commit -m "message"
  • NOTE: A PR should have only one commit. Multiple commits should be squashed.

Step 5 : Work Remotely

  • Now you are ready to your work to the remote repository.
  • When your work is ready and complies with the project conventions, upload your changes to your fork:
# To push your work to your remote repository
git push -u origin Branch_Name
  • Here is how your branch will look. Branch

Step 6 : Pull Request

  • Go to your repository in the browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.

PR

  • Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳

Tip from us😇

It always takes time to understand and learn. So, do not worry at all. We know you have got this!💪

Specific tips on React

Welcome aboard! You can learn more in the Create React App documentation.