From 3dad8a8322192bd262ded951be73ccef8eca3bfb Mon Sep 17 00:00:00 2001 From: miguelgfierro Date: Sun, 7 Jan 2024 09:26:26 +0100 Subject: [PATCH 1/4] Updated PR template Signed-off-by: miguelgfierro --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1d81942d0d..aef2bab9bc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,8 @@ ### Checklist: -- [ ] I have followed the [contribution guidelines](../CONTRIBUTING.md) and code style for this project. +- [ ] I have followed the [contribution guidelines](CONTRIBUTING.md) and code style for this project. - [ ] I have added tests covering my contributions. - [ ] I have updated the documentation accordingly. -- [ ] This PR is being made to `staging branch` and not to `main branch`. +- [ ] I have [signed the commits](https://github.com/recommenders-team/recommenders/wiki/How-to-sign-commits), i.e. `git commit -s -m "your commit message"`. +- [ ] This PR is being made to `staging branch` AND NOT TO `main branch`. From d4e3d896c6f90fef61abacb4b7d12c8a87646260 Mon Sep 17 00:00:00 2001 From: miguelgfierro Date: Sun, 7 Jan 2024 09:29:01 +0100 Subject: [PATCH 2/4] Updated contributing Signed-off-by: miguelgfierro --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index aef2bab9bc..04313f43c7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,5 +18,5 @@ - [ ] I have followed the [contribution guidelines](CONTRIBUTING.md) and code style for this project. - [ ] I have added tests covering my contributions. - [ ] I have updated the documentation accordingly. -- [ ] I have [signed the commits](https://github.com/recommenders-team/recommenders/wiki/How-to-sign-commits), i.e. `git commit -s -m "your commit message"`. +- [ ] I have [signed the commits](https://github.com/recommenders-team/recommenders/wiki/How-to-sign-commits), e.g. `git commit -s -m "your commit message"`. - [ ] This PR is being made to `staging branch` AND NOT TO `main branch`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4be1443b4d..10ce7c87e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Contributions are welcomed! Here's a few things to know: Here are the basic steps to get started with your first contribution. Please reach out with any questions. 1. Use [open issues](https://github.com/Microsoft/Recommenders/issues) to discuss the proposed changes. Create an issue describing changes if necessary to collect feedback. Also, please use provided labels to tag issues so everyone can easily sort issues of interest. 1. [Fork the repo](https://help.github.com/articles/fork-a-repo/) so you can make and test local changes. -1. Create a new branch **from staging branch** for the issue (please do not create a branch from main). We suggest prefixing the branch with your username and then a descriptive title: (e.g. gramhagen/update_contributing_docs) +1. Create a new branch **from staging branch** for the issue (please do not create a branch from main). We suggest prefixing the branch with your username and then a descriptive title: (e.g. `gramhagen/update_contributing_docs`) 1. Install recommenders package locally using the right optional dependency for your test and the dev option. (e.g. gpu test: `pip install -e .[gpu,dev]`) 1. Create a test that replicates the issue. 1. Make code changes. @@ -31,7 +31,7 @@ Here are the basic steps to get started with your first contribution. Please rea 1. When adding code to the repo, make sure you sign the commits, otherwise the tests will fail (see [how to sign the commits](https://github.com/recommenders-team/recommenders/wiki/How-to-sign-commits)). 1. Create a pull request against **staging** branch. -Once the features included in a [milestone](https://github.com/microsoft/recommenders/milestones) are completed, we will merge staging into main. See the wiki for more detail about our [merge strategy](https://github.com/microsoft/recommenders/wiki/Strategy-to-merge-the-code-to-main-branch). +See the wiki for more details about our [merge strategy](https://github.com/microsoft/recommenders/wiki/Strategy-to-merge-the-code-to-main-branch). ## Coding Guidelines From 9efd1353fd54f695605389e85812ff37b5faf99e Mon Sep 17 00:00:00 2001 From: miguelgfierro Date: Sun, 7 Jan 2024 09:32:53 +0100 Subject: [PATCH 3/4] Updated PR template and contributing Signed-off-by: miguelgfierro --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 04313f43c7..b56c89b48a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ ### Checklist: -- [ ] I have followed the [contribution guidelines](CONTRIBUTING.md) and code style for this project. +- [ ] I have followed the [contribution guidelines](https://github.com/recommenders-team/recommenders/blob/main/CONTRIBUTING.md) and code style for this project. - [ ] I have added tests covering my contributions. - [ ] I have updated the documentation accordingly. - [ ] I have [signed the commits](https://github.com/recommenders-team/recommenders/wiki/How-to-sign-commits), e.g. `git commit -s -m "your commit message"`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10ce7c87e2..217c1c900d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ Here are the basic steps to get started with your first contribution. Please rea 1. When adding code to the repo, make sure you sign the commits, otherwise the tests will fail (see [how to sign the commits](https://github.com/recommenders-team/recommenders/wiki/How-to-sign-commits)). 1. Create a pull request against **staging** branch. -See the wiki for more details about our [merge strategy](https://github.com/microsoft/recommenders/wiki/Strategy-to-merge-the-code-to-main-branch). +See the wiki for more details about our [merging strategy](https://github.com/microsoft/recommenders/wiki/Strategy-to-merge-the-code-to-main-branch). ## Coding Guidelines From 658e7e51131e8a66650b003d84af7cf840b245c2 Mon Sep 17 00:00:00 2001 From: miguelgfierro Date: Sun, 7 Jan 2024 09:33:47 +0100 Subject: [PATCH 4/4] Updated contributing Signed-off-by: miguelgfierro --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b56c89b48a..04313f43c7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ ### Checklist: -- [ ] I have followed the [contribution guidelines](https://github.com/recommenders-team/recommenders/blob/main/CONTRIBUTING.md) and code style for this project. +- [ ] I have followed the [contribution guidelines](CONTRIBUTING.md) and code style for this project. - [ ] I have added tests covering my contributions. - [ ] I have updated the documentation accordingly. - [ ] I have [signed the commits](https://github.com/recommenders-team/recommenders/wiki/How-to-sign-commits), e.g. `git commit -s -m "your commit message"`.