search

oppia / oppia-web-developer-docs

Repo for Web developer documentation on Oppia. For contribution instructions, see: https://github.com/oppia/oppia/wiki/Wiki#contributing-to-the-wiki
Apache License 2.0
12 stars 99 forks source link

Fix #336: Fold "Common pull request workflows" into "Rules for making PRs" #393

Closed miro789 closed 1 month ago

miro789 commented 1 month ago

Contribution Proposal

  1. This PR fixes ##336
  2. This PR update by integrating the content from "Common pull request workflows" into "Rules for making PRs." (currently at https://github.com/oppia/oppia/wiki/Make-a-pull-request)

Essential Checklist

  1. Steps to Keep: Retain the original content for Step 1, Step 2, Step 3, Step 5, Step 6, and Step 7.

  2. Modifications: Update some of the original content in the “Make a pull request” file and incorporate information from "Common Pull Request Workflows", specifically:

    • Step 4: Pull Request Lifecycle, Draft Pull Requests, Labeling Pull Requests
    • Step 8: Working on Multiple Pull Requests For more details, please refer here.

To fully address these issues, I believe the following steps are necessary. However, they are beyond my current capabilities, so please review and complete them:

  1. Remove the wiki page: Common pull request workflows.
  2. Rename the file: Change the filename from "Make-a-pull-request" to "Rules for making PRs".
  3. Update the wiki page and menu tab: Refer to this screenshot for details
U8NWXD commented 1 month ago

Thanks for working on this @miro789! I'm planning to take a look in about 24 hrs

seanlip commented 1 month ago

@miro789 I took a quick look at your PR and noticed the last paragraph. Could you please clarify what you mean by "please review and complete them" for the last three steps?

Note that if you have a local version of oppia-web-developer-docs checked out, you should be able to remove/rename files in the filesystem and those should show up as changes on git. You can update the sidebar in _Sidebar.md if needed.

Please let us know in more detail what you're having trouble with when performing these operations, and we can try to assist. You can use GitHub Discussions if your query is a general one.

Thanks!

miro789 commented 1 month ago

Hi @U8NWXD, Thanks for your detailed and specific instructions. I appreciate your care for each part—I've learned much from it.

I've reviewed all the contents inside files relevant to pull requests (PR) like: Instructions-for-making-PR-passes.md, If-CI-checks-fail-on-your-PR.md, etc. The Common-pull-request-workflows file only appears in the Make a pull request, and I've already covered the relevant part. Please double-check and let me know if any other related files mention Common-pull-request-workflows which I might have missed. Many thanks.

Essential Checklist

1. Address changes in the "Make-a-pull-request" file:

2. Rename the file:

3. Update Sidebar in _Sidebar.md file:

4. Delete the "Common-pull-request-workflows" file.

U8NWXD commented 1 month ago

Thanks @miro789! I'm planning to re-review in the next 12 hrs or so