search

moja-global / moja_global_docs

Repository to host the moja global technical documentation
https://docs.moja.global/en/master/
Mozilla Public License 2.0
35 stars 67 forks source link

Communication Suggestion: Update the Pull Request Template #96

Closed HarshCasper closed 3 years ago

HarshCasper commented 3 years ago

Describe how we are communicating and why it is not optimal.

The current Pull Request template is highly skewed towards development projects, not for documentation related work. You can view the existing PR template.

We would want it to be updated for the purpose of reporting documentation changes more appropriately.

Describe the solution you'd like.

We can add the following sections to the Pull Request template:

Describe alternatives you've considered.

No response

Additional context.

No response

aornugent commented 3 years ago

IMO - our current PR template is too much. Maybe we can go for something simpler and more general that covers the majority of potential use cases?

PRs need to:

  1. describe the changes
  2. not break anything
  3. close an issue
  4. ?
shraddhavp commented 3 years ago

@aornugent and @HarshCasper would like to contribute to the issue

HarshCasper commented 3 years ago

IMO - our current PR template is too much. Maybe we can go for something simpler and more general that covers the majority of potential use cases?

PRs need to:

  1. describe the changes
  2. not break anything
  3. close an issue
  4. ?

I agree. The CI parts take care if something breaks or not. For the Docs part, it would be necessary to have a look at the rendered docs though, as it makes things easy for us to review. I will make an issue on About_moja_global for the PR template update.