Feature Request: - Adding A Git guide for contributors

[Biki-das]

Is your feature request related to a problem? Please describe. I Have seen many new contributors facing merge conflict issues, pushing old code etc because they have not added upstream to their local repository which is common for beginners as they are just starting, Mentioning the same forehand can be really helpful to beginner contributors to prevent such issues and thus they can concentrate on contributing.

This evolved from a simple issue to a comprehensive git guide for talawa as suggested by the maintainers!

Describe the solution you'd like Adding an entirely new section for git guide

Describe alternatives you've considered N/A Approach to be followed (optional) Writing the Guidelines in the appropriate segment
Below is the screenshot of what i would like to write

Additional context N/A

Potential internship candidates Please read this if you are planning to apply for a Palisadoes Foundation internship https://github.com/PalisadoesFoundation/talawa/issues/359

I would like to work on this issue!

[palisadoes]

This is insufficient. We need a generic guide like this.

• https://zulip.readthedocs.io/en/latest/git/index.html

It must:

1. Have its own section on the site.
2. Clearly explain that it's using talawa-docs as a reference but that it would apply to any of our repositories.
3. Show people that we are only accepting PRs to the develop branch of each repository.

[Biki-das]

@palisadoes ok let me research on the above and i shall create a new section for the same. thanks for the feedback

[palisadoes]

Please work with @Cioppolo14 on this.

[Biki-das]

@Cioppolo14 let start with what important things we can include here?

[palisadoes]

Source files.

• https://github.com/zulip/zulip/tree/main/docs/git

[Biki-das]

@palisadoes could you assign the issue to me? i have started drafting the initial structure for how the workflow guidelines should be in respect to talawa!

[palisadoes]

Please work with @Cioppolo14 on this. Please don't ping me. I've been getting too many interrupts in my day.

[Biki-das]

Please work with @Cioppolo14 on this. Please don't ping me. I've been getting too many interrupts in my day.

sure! sorry for the ping!

[Cioppolo14]

@Biki-das I am going to look at this more. Keep me updated with what you have.

[Biki-das]

@Cioppolo14 since i am writing this guide we currently do not have a linter for our docs, which does not seem to proivde a good experience for contributors adding the same can be a good step to go forward, looking forward to your thoughts?

cc @tasneemkoushar

[Cioppolo14]

@Biki-das That may be a possibility in the future, and Tasneem would have better input, but first lets get this guide going based on Palisadoes previously mentioned guidelines.

[Biki-das]

@Cioppolo14 should i make the git guide inside the developer resources section or it should have a section of its own?

[Cioppolo14]

@Biki-das Its own section so it easiest to find.

[Biki-das]

@Biki-das Its own section so it easiest to find.

thanks for the feedback!

[Biki-das]

@Cioppolo14 wrote the first quickstart for Talawa

could you give some feedback?

[Cioppolo14]

@Biki-das It looks like a good format for the quickstart page. I think the first two sentences can be combined (the word detailed can be removed, this is a quickstart, not the detailed version), and there are several typos throughout that need to be fixed. Please change good luck to "Thank you!". Also, I think we should add a final bullet containing some details about how we handles PRs based on our available volunteers. Something that says, "We are a small non-profit with limited volunteer resources. We have the following rules in place for PRs to ensure we can manage Talawa's GITHUB repos as efficently as possible:

• Please ensure your PR passes all tests and there are no merge conflicts.
• Please do not submit draft PRs.
• Read our CONTRIBUTING.md file. Most importantly:

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

[Biki-das]

@Biki-das It looks like a good format for the quickstart page. I think the first two sentences can be combined (the word detailed can be removed, this is a quickstart, not the detailed version), and there are several typos throughout that need to be fixed. Please change good luck to "Thank you!". Also, I think we should add a final bullet containing some details about how we handles PRs based on our available volunteers. Something that says, "We are a small non-profit with limited volunteer resources. We have the following rules in place for PRs to ensure we can manage Talawa's GITHUB repos as efficently as possible:

* Please ensure your PR passes all tests and there are no merge conflicts.

* Please do not submit draft PRs.

* Read our CONTRIBUTING.md file. Most importantly:

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

thanks for this detailed review! yes i was thinking of adding these rules.

[Biki-das]

@Cioppolo14 i have updated the quick start and made changes as you said, here are the changes, i think this is enough for the quick start part, i am currently now writing the guide for setting up git in local machine-

[Biki-das]

@Cioppolo14 i have written the guide for getting the code could you give some feebdack?

[Cioppolo14]

@Biki-das Thank you. I have the following comments: 1) Please read through it for grammar and capitalization issues 2) At the beginning, clearly state that this example is for talawa-docs, but can be tweaked by repository name to be used for any Talawa repo. 3) Please redo the examples to be the exact commands for Talawa-Docs. It might be helpful to finish it with a brief table or blurb about what would be changed for the other talawa repos.

[Biki-das]

@Cioppolo14 shouldn't we refer to talawa mobile app setup as the default one and as you said to redo the commands, its exactly similar so i think just stating the same will be followed would be sufficient?

[Cioppolo14]

@Biki-das Palisadoes requested it use talawa-docs as the example in the above discussion. I don't think we need to ping them to ask, I think we should just follow their vision.

[Biki-das]

@Biki-das Palisadoes requested it use talawa-docs as the example in the above discussion. I don't think we need to ping them to ask, I think we should just follow their vision.

yeah, lets go with the approach suggested by palisadoes.

[Biki-das]

@Cioppolo14 work update! added a working copies and a detailed workflow guide section please review, quite a lot of work done 😅

Working copies section

Workflow section

[Cioppolo14]

@Biki-das I am having some internet challenges, but I think you have the idea down. Just make sure to proofread everything. I'll give comments once my internet is more reliable.

[Biki-das]

@Biki-das I am having some internet challenges, but I think you have the idea down. Just make sure to proofread everything. I'll give comments once my internet is more reliable.

sure i have completed the guide now just checking if links are ok and grammer etc is fine. currently what i have written would be enough for now later in future we can add more changes as needed!