search

PalisadoesFoundation / talawa-docs

Documentation for Talawa and Talawa-API
https://docs.talawa.io/
GNU General Public License v3.0
44 stars 146 forks source link

Feat:-Added git guide for docs #643

Closed Biki-das closed 1 year ago

Biki-das commented 1 year ago

What kind of change does this PR introduce?

feature

Issue Number:

Fixes #624

Did you add tests for your changes?

N/A

Snapshots/Videos:

If relevant, did you update the documentation?

N/A

Summary

This PR adds a Git guide for contributors, it has git and code setup guide along with rules related to creating Pull request , commits etc Does this PR introduce a breaking change?

NO

Other information

Have you read the contributing guide? Yes

github-actions[bot] commented 1 year ago

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests and there are no merge conflicts.

The process helps maintain accurate and well-formatted documentation and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. :dart: Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
Cioppolo14 commented 1 year ago

@Biki-das Thank you! Its going to take me a few days to give this the time it needs.

Biki-das commented 1 year ago

@Biki-das Thank you! Its going to take me a few days to give this the time it needs.

sure :-)

Biki-das commented 1 year ago

@Cioppolo14 thanks for the review , let me fix the sections as you suggested!

Biki-das commented 1 year ago

@Cioppolo14 the recent commit only includes the wording and sentences changes, the sidebar changes as you requested would be done in another commit or else it might became hard for you to go through :-)

Biki-das commented 1 year ago

@Cioppolo14 done with the changes, and tried my best to articulate the changes as you requested! looking forward to your review!

Sidebar has been revamped

Biki-das commented 1 year ago

@Cioppolo14 changes pushed! thanks for the feedback! we really need a linter as i had to manually lint so many files. this becomes too cumbersome!

Biki-das commented 1 year ago

@Cioppolo14 thanks for the cooperation and feedback , without this, it won't have been possible to get so far with this one. Looking forward to contributing more!