From 97f31ddbde86c344c22d8ff82c56cf8dfdd8fa83 Mon Sep 17 00:00:00 2001 From: ibevers Date: Fri, 12 Apr 2024 16:54:53 -0400 Subject: [PATCH 1/6] Add workflow expectations to CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3cf01f7..7969c48 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,23 @@ # pipepal pull request guidelines + + + + Pull requests are always welcome, and we appreciate any help you give. Note that a code of conduct applies to all spaces managed by the pipepal project, including issues and pull requests. Please see the [Code of Conduct](CODE_OF_CONDUCT.md) for details. +### Workflow +Please use the following workflow when contributing: +1. If you have access, add a task to the project board: https://github.com/orgs/sensein/projects/45 +2. Create an issue (with the same name as the task, if applicable), +3. Use GitHub's "Create a branch" button from the issue page to generate a branch associated with the issue +4. Fork the issue branch +5. Work locally on the forked issue branch +6. Submit a pull request to merge the forked issue branch into the upstream issue branch +7. After the pull request from 6 is merged, submit a pull request to merge the upstream issue branch into upstream main + +This approach ensures that tasks, issues, and branches all have names that clearly correspond. It also facilitates incremental neatly scoped changes since it tends to keep the scope of individual changes narrow. + When submitting a pull request, we ask you to check the following: 1. **Unit tests**, **documentation**, and **code style** are in order. @@ -10,3 +26,4 @@ When submitting a pull request, we ask you to check the following: It is also OK to submit work in progress if you're unsure of what this exactly means, in which case you'll likely be asked to make some further changes. 2. The contributed code will be **licensed under the same [license](LICENSE) as the rest of the repository**, If you did not write the code yourself, you must ensure the existing license is compatible and include the license information in the contributed files, or obtain permission from the original author to relicense the contributed code. + From f7e650234b30de102e3e550bb3f61a818eb127cf Mon Sep 17 00:00:00 2001 From: ibevers Date: Fri, 12 Apr 2024 17:23:38 -0400 Subject: [PATCH 2/6] Add reference in README.md to CONTRIBUTING.md --- CONTRIBUTING.md | 7 +------ README.md | 3 +++ 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7969c48..fdbe54f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,4 @@ -# pipepal pull request guidelines - - - - - +## pipepal pull request guidelines Pull requests are always welcome, and we appreciate any help you give. Note that a code of conduct applies to all spaces managed by the pipepal project, including issues and pull requests. Please see the [Code of Conduct](CODE_OF_CONDUCT.md) for details. ### Workflow diff --git a/README.md b/README.md index 5ccb13c..2355891 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,9 @@ from pipepal.app import hello_world hello_world() ``` +## Contributing +Please see CONTRIBUTING.md before contributing. + ## To do: - [ ] Integrating more audio tasks and moving functions from b2aiprep package: - [ ] data_augmentation From fbdf5e2f7ae94bc629f85e34fc6dd4a09ae08477 Mon Sep 17 00:00:00 2001 From: ibevers Date: Fri, 12 Apr 2024 17:28:32 -0400 Subject: [PATCH 3/6] Add note about suggesting changes to workflow --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fdbe54f..af0fdc9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,8 @@ Please use the following workflow when contributing: This approach ensures that tasks, issues, and branches all have names that clearly correspond. It also facilitates incremental neatly scoped changes since it tends to keep the scope of individual changes narrow. +If you would like to change this workflow, please use the current workflow process to suggest a change to this document. + When submitting a pull request, we ask you to check the following: 1. **Unit tests**, **documentation**, and **code style** are in order. @@ -22,3 +24,5 @@ When submitting a pull request, we ask you to check the following: 2. The contributed code will be **licensed under the same [license](LICENSE) as the rest of the repository**, If you did not write the code yourself, you must ensure the existing license is compatible and include the license information in the contributed files, or obtain permission from the original author to relicense the contributed code. + + From 3be99d7d47e5371cf9cb18c766116e69a6455790 Mon Sep 17 00:00:00 2001 From: fabiocat93 Date: Mon, 22 Apr 2024 17:53:16 -0400 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2355891..172c6a7 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ hello_world() ``` ## Contributing -Please see CONTRIBUTING.md before contributing. +Please see [CONTRIBUTING.md](https://github.com/ibevers/pipepal/blob/main/CONTRIBUTING.md) before contributing. ## To do: - [ ] Integrating more audio tasks and moving functions from b2aiprep package: From 0371e9f0362947548d5ea2f1987978094d24cbc1 Mon Sep 17 00:00:00 2001 From: fabiocat93 Date: Mon, 22 Apr 2024 17:54:40 -0400 Subject: [PATCH 5/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af0fdc9..81f9f7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Pull requests are always welcome, and we appreciate any help you give. Note that ### Workflow Please use the following workflow when contributing: -1. If you have access, add a task to the project board: https://github.com/orgs/sensein/projects/45 +1. If you have access, add a task to the [project board](https://github.com/orgs/sensein/projects/45) 2. Create an issue (with the same name as the task, if applicable), 3. Use GitHub's "Create a branch" button from the issue page to generate a branch associated with the issue 4. Fork the issue branch From cd50e27eb0e7ebf7a8a5db7e157d5a246e9498a0 Mon Sep 17 00:00:00 2001 From: fabiocat93 Date: Mon, 22 Apr 2024 17:55:26 -0400 Subject: [PATCH 6/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 172c6a7..abf9169 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ hello_world() ``` ## Contributing -Please see [CONTRIBUTING.md](https://github.com/ibevers/pipepal/blob/main/CONTRIBUTING.md) before contributing. +Please see [CONTRIBUTING.md](CONTRIBUTING.md) before contributing. ## To do: - [ ] Integrating more audio tasks and moving functions from b2aiprep package: