From fc60d505b3515ce8e62d862b1ff6dd7a806a8fc9 Mon Sep 17 00:00:00 2001 From: Jyotika999 Date: Mon, 18 Oct 2021 17:11:17 +0530 Subject: [PATCH 1/4] Added PR Template and connected to contributing.md --- docs/CONTRIBUTING.md | 2 +- docs/PR_template.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docs/PR_template.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 53ba3f4e..3141d6e1 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -5,7 +5,7 @@ - Follow our [Commit Message Style Guide](https://github.com/anitab-org/mentorship-android/wiki/Commit-Message-Style-Guide) when you commit your changes. - Please consider raising an issue before submitting a pull request (PR) to solve a problem that is not present in our [issue tracker](https://github.com/anitab-org/anitab-org.github.io/issues). This allows maintainers to first validate the issue you are trying to solve and also reference the PR to a specific issue. - When developing a new feature, include at least one test when applicable. -- When submitting a PR, please follow [this template](.github/PULL_REQUEST_TEMPLATE/pull_request_template.md) (which will probably be already filled up once you create the PR). +- When submitting a PR, please follow [this template](https://github.com/anitab-org/anitab-org.github.io/blob/develop/docs/PR_template.md) (which will probably be already filled up once you create the PR). - When submitting a PR with changes to user interface (e.g.: new screen, ...), please add screenshots to the PR description. - When submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR. - When you are finished with your work, please squash your commits otherwise we will squash them on your PR (this can help us maintain a clear commit history). diff --git a/docs/PR_template.md b/docs/PR_template.md new file mode 100644 index 00000000..298a7052 --- /dev/null +++ b/docs/PR_template.md @@ -0,0 +1,40 @@ +### Description +Include a summary of the change and relevant motivation/context. List any dependencies that are required for this change. + +Fixes # [ISSUE] + +### Type of Change: +**Delete irrelevant options.** + +- Code +- Quality Assurance +- User Interface +- Outreach +- Documentation + +**Code/Quality Assurance Only** +- Bug fix (non-breaking change which fixes an issue) +- This change requires a documentation update (software upgrade on readme file) +- New feature (non-breaking change which adds functionality pre-approved by mentors) + + + +### How Has This Been Tested? +Describe the tests you ran to verify your changes. Provide instructions or GIFs so we can reproduce. List any relevant details for your test. + + +### Checklist: +**Delete irrelevant options.** + +- [ ] My PR follows the style guidelines of this project +- [ ] I have performed a self-review of my own code or materials +- [ ] I have commented my code or provided relevant documentation, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] Any dependent changes have been merged + +**Code/Quality Assurance Only** +- [ ] My changes generate no new warnings +- [ ] My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected) +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been published in downstream modules \ No newline at end of file From e8ec27fda72d070210f29e98f6d8502933959db7 Mon Sep 17 00:00:00 2001 From: Jyotika999 Date: Mon, 18 Oct 2021 17:17:24 +0530 Subject: [PATCH 2/4] docs : changes in contributing.md --- docs/CONTRIBUTING.md | 2 +- docs/PR_template.md | 40 ---------------------------------------- 2 files changed, 1 insertion(+), 41 deletions(-) delete mode 100644 docs/PR_template.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3141d6e1..6e4d85a7 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -5,7 +5,7 @@ - Follow our [Commit Message Style Guide](https://github.com/anitab-org/mentorship-android/wiki/Commit-Message-Style-Guide) when you commit your changes. - Please consider raising an issue before submitting a pull request (PR) to solve a problem that is not present in our [issue tracker](https://github.com/anitab-org/anitab-org.github.io/issues). This allows maintainers to first validate the issue you are trying to solve and also reference the PR to a specific issue. - When developing a new feature, include at least one test when applicable. -- When submitting a PR, please follow [this template](https://github.com/anitab-org/anitab-org.github.io/blob/develop/docs/PR_template.md) (which will probably be already filled up once you create the PR). +- When submitting a PR, please follow [this template](https://github.com/anitab-org/powerup-iOS/blob/develop/PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR). - When submitting a PR with changes to user interface (e.g.: new screen, ...), please add screenshots to the PR description. - When submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR. - When you are finished with your work, please squash your commits otherwise we will squash them on your PR (this can help us maintain a clear commit history). diff --git a/docs/PR_template.md b/docs/PR_template.md deleted file mode 100644 index 298a7052..00000000 --- a/docs/PR_template.md +++ /dev/null @@ -1,40 +0,0 @@ -### Description -Include a summary of the change and relevant motivation/context. List any dependencies that are required for this change. - -Fixes # [ISSUE] - -### Type of Change: -**Delete irrelevant options.** - -- Code -- Quality Assurance -- User Interface -- Outreach -- Documentation - -**Code/Quality Assurance Only** -- Bug fix (non-breaking change which fixes an issue) -- This change requires a documentation update (software upgrade on readme file) -- New feature (non-breaking change which adds functionality pre-approved by mentors) - - - -### How Has This Been Tested? -Describe the tests you ran to verify your changes. Provide instructions or GIFs so we can reproduce. List any relevant details for your test. - - -### Checklist: -**Delete irrelevant options.** - -- [ ] My PR follows the style guidelines of this project -- [ ] I have performed a self-review of my own code or materials -- [ ] I have commented my code or provided relevant documentation, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] Any dependent changes have been merged - -**Code/Quality Assurance Only** -- [ ] My changes generate no new warnings -- [ ] My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected) -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] Any dependent changes have been published in downstream modules \ No newline at end of file From 82b6e7bc34c516f3451aa55c5cdbe039bf7655e1 Mon Sep 17 00:00:00 2001 From: Jyotika <54600270+Jyotika999@users.noreply.github.com> Date: Mon, 18 Oct 2021 21:22:34 +0530 Subject: [PATCH 3/4] Update docs/CONTRIBUTING.md Co-authored-by: Isabel Costa <11148726+isabelcosta@users.noreply.github.com> --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 6e4d85a7..f90dfb5f 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -5,7 +5,7 @@ - Follow our [Commit Message Style Guide](https://github.com/anitab-org/mentorship-android/wiki/Commit-Message-Style-Guide) when you commit your changes. - Please consider raising an issue before submitting a pull request (PR) to solve a problem that is not present in our [issue tracker](https://github.com/anitab-org/anitab-org.github.io/issues). This allows maintainers to first validate the issue you are trying to solve and also reference the PR to a specific issue. - When developing a new feature, include at least one test when applicable. -- When submitting a PR, please follow [this template](https://github.com/anitab-org/powerup-iOS/blob/develop/PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR). +- When submitting a PR, please follow [this template](/.github/PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR). - When submitting a PR with changes to user interface (e.g.: new screen, ...), please add screenshots to the PR description. - When submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR. - When you are finished with your work, please squash your commits otherwise we will squash them on your PR (this can help us maintain a clear commit history). From ae970a0a001f7947655e388f102f598c34f4cf25 Mon Sep 17 00:00:00 2001 From: Jyotika999 Date: Wed, 27 Oct 2021 11:11:33 +0530 Subject: [PATCH 4/4] Shifted Contributing.md to .github folder --- {docs => .github}/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename {docs => .github}/CONTRIBUTING.md (95%) diff --git a/docs/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 95% rename from docs/CONTRIBUTING.md rename to .github/CONTRIBUTING.md index f90dfb5f..43c63eb0 100644 --- a/docs/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,7 +5,7 @@ - Follow our [Commit Message Style Guide](https://github.com/anitab-org/mentorship-android/wiki/Commit-Message-Style-Guide) when you commit your changes. - Please consider raising an issue before submitting a pull request (PR) to solve a problem that is not present in our [issue tracker](https://github.com/anitab-org/anitab-org.github.io/issues). This allows maintainers to first validate the issue you are trying to solve and also reference the PR to a specific issue. - When developing a new feature, include at least one test when applicable. -- When submitting a PR, please follow [this template](/.github/PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR). +- When submitting a PR, please follow [this template](PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR). - When submitting a PR with changes to user interface (e.g.: new screen, ...), please add screenshots to the PR description. - When submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR. - When you are finished with your work, please squash your commits otherwise we will squash them on your PR (this can help us maintain a clear commit history).