Skip to content

Latest commit

 

History

History
195 lines (144 loc) · 9.55 KB

CONTRIBUTING.md

File metadata and controls

195 lines (144 loc) · 9.55 KB
Raw

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 this project. Thank you for helping out and remember, no contribution is too small.

  • Join the discord channel for regular updates.

  • Each participant/contributor will be assigned 2 issues (max) at a time to work.

  • Participants are expected to follow project guidelines and coding style.

  • Participants/contributors have to give an update about their work in every 3 days while completing issues. If not then the issue will be assigned to other.

  • Participants/contributors have to comment on issues they would like to work on, and mentors will assign you. Direct PRs for Open to all issues .

  • Issues will be assigned on a first-come, first-serve basis.

  • Participants/contributors can also open their issues, but it needs to be verified and labelled by a mentor.

  • Before opening a new issue, please check if it is already created or not.

  • Pull requests will be merged after being reviewed by a mentor.

  • Create a pull request from a branch other than gssoc ,that means you have to create a new branch for every pull request.

  • It might take a day to review your pull request. Please have patience and be nice.

  • We all are here to learn. You are allowed to make mistakes. That's how you learn, right!

  • MAKE SURE TO OPEN A DRAFT PR AS SOON AS YOU START WORKING ON AN ISSUE AND KEEP COMMITING TO IT SO THAT WE CAN KNOW THAT YOU ARE WORKING ON THAT PARTICULAR ISSUE

  • Pull Requests review criteria:

    • Please fill the PR template properly while making a PR.
    • Example of the PR template
    • You must add your designs file into the respective folders.
    • Your work must be original, designed/written by you not copied from other resources.
    • You must comment on your code where necessary.
    • For frontend changes, kindly share screenshots and work samples of your work before sending a PR.

  • For any queries or discussions, please drop a message in our discord server.

Submissions

(Use "Fixes #Issue_Number" in a pull request as mentioned in the PR template and please fill the PR details while creating a pull request )

Idea submission

For idea submission {issue} Add the idea in the ideas.md . You have to add a proper description about the idea and features for the idea(like how we can implement the idea). If you have any design/mockup/workflow for the idea you can also add them . The ideas should be unique or innovative. Please read the issue properly and then make a PR.

Design submission

For design submission : First make a new folder in Designs folder and add a html file in it . The name of the folder and html file should be same as the idea name on which the design is made(try to keep it precise).

(The html file should follow the template - TEMPLATE)

Along with the html file add all the photos of the design screens (.png or .jpg format).

Files : Designs/your_design_idea/your_design_idea.html
        Designs/your_design_idea/screen_1.png or Designs/your_design_idea/screen_1.jpg
        Designs/your_design_idea/screen_2.png or Designs/your_design_idea/screen_2.jpg
        ...(add all the screens)

For designs having 2 assignees - Divide half-half screens and then both can make a pull request. The HTML file should be added by one assignee. To keep the folder same - first, one assignee has to make a pull request and then, when it gets merged, the second assignee should add the remaining files in the same folder.

Website Design submission

Go to Designs/Website folder. In that folder, add a new folder and then add the photos of your designs in that folder. Also add a html file in it (The html file should follow the template - TEMPLATE).

Fill all the details in the html file and add the figma link of your design in it.

Code submission

All the information would be given in the issue.

Documentation submission

All the information would be given in the issue.

How to start

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.

image

Step 1 : Fork the Project 🍴 and clone it

  • 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.

image

  • After this go to your terminal and clone this project on your desktop( git should be installed before - link ).
$ git clone https://github.com/<your-username>/Desgen 
$ cd <repo-name>  
$ git remote add upstream https://github.com/awantika10/Desgen
  • Update your forked repo 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 are addressing.

image

# 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 using terminal:
# To add all new files to branch Branch_Name  
$ git add .  

# To add only a few files to Branch_Name
$ git add <some files>
  • Using GitHub:

image

Step 4 : Commit

  • To commit give a descriptive message for the convenience of reviewer by using terminal:
# This message get associated with all files you have changed. 
$ git commit -m "message"
  • Using GitHub

commit

Commit message guidelines

  • Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Example commit message

feat(Profile): display QR code

fetch the QR code from API and display it on the Profile page (ProfileFragment.kt)

fixes #1234

A good rule of thumb for the commit message is to have a present tense verb, followed by whatever it is you're doing in as much detail as possible in 50 chars. Capitalize words correctly and follow general English.

For more details, visit

Step 5 : Work Remotely

  • Now you are ready to work in 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.

image

Step 6 : Pull Request 🎣

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

compare

  • Create pull request pullrequest

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

Need more help?🤔

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

Tip from us😇

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