From 0a1100b1e7b399588ca35764260c7c44372ad5f3 Mon Sep 17 00:00:00 2001 From: Daniel Shown Date: Fri, 20 Oct 2023 13:34:35 -0500 Subject: [PATCH 1/5] update community section to better reflect a clear onboarding path for volunteers --- docs/about/community.md | 28 +++++++++++++++++++++++----- docs/about/contributors.md | 5 +++++ 2 files changed, 28 insertions(+), 5 deletions(-) create mode 100644 docs/about/contributors.md diff --git a/docs/about/community.md b/docs/about/community.md index c7703d2c..b94ebe47 100644 --- a/docs/about/community.md +++ b/docs/about/community.md @@ -1,22 +1,40 @@ --- id: community -title: Community Engagement custom_edit_url: null --- + # Community Partners ## About + We welcome the participation of anyone interested in contributing to the projects in our portfolio. You can work on open issues on projects in our portfolio, create a new issue, or e-mail us if you want to be more involved. +Join the conversation in the Open Sourc with SLU [Slack workspace](https://join.slack.com/t/oswslu/shared_invite/zt-24f0qhjbo-NkSfQ4LOg5wXxBdxP4vzfA) + +## Overview + +* Join our Slack workspace. +* Contribute changes to an Open Source with SLU project. +* Add your name to the Contributors list. +* After making five contributions, you can be added to the `oss-slu` team in GitHub by contacting one of the program staff. + +## Getting Startted + +Anyone interested in getting involved with Open Source with SLU projects can sign up by opening a [Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on the [contributors](contributors.md) page in this website. The PR will be merged when it includes a link to a merged ticket from a project in the [portfolio](../portfoliio.md) that they made contribution to, and the PR has been approved by the current tech lead on that project. + ## Git -All our projects are stored in public GitHub repositories. To make code contributions to our repositories, you will need to know the basics about Git and GitHub. We recommend this video tutorial, if you are not familiar with these tools. + +All our projects are stored in public GitHub repositories. To make code contributions to our repositories, you will need to know the basics about Git and GitHub. We recommend this [video tutorial]("https://youtu.be/RGOj5yH7evk"), if you are not familiar with these tools. + ## Guidance + When you are ready to contribute code to one of our open-source project, here is the process you should follow: + 1. Identify the issue you want to work on and post a comment in this issue, asking the repo maintainer to assign the issue to you. -2. Crate a fork of our repository. Here is GitHub documentation for how to create a fork -3. Clone your fork of the repository. Here is GitHub documentation for how to clone a repository. +2. Crate a fork of our repository. Here is GitHub documentation for how to [create a fork]("https://docs.github.com/en/enterprise-cloud@latest/get-started/quickstart/fork-a-repo") +3. Clone your fork of the repository. Here is GitHub documentation for how to clone [a repository]("https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository"). 4. Follow the developer guide to install project dependencies and run the code. 5. Make the necessary code changes to resolve the issue. Commit and push your changes frequently. Use meaningful commit messages when committing your code. 6. Test your changes, verifying that the issue is resolved. -7. Create a pull request - a request to merge changes from your fork of the repository to the original repository. Here is GitHub documentation for how to create a pull request. Make sure to note the issue number that your pull request resolves, and include details of your solution. +7. Create a pull request - a request to merge changes from your fork of the repository to the original repository. Here is GitHub documentation for how to [create a pull request]("https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork"). Make sure to note the issue number that your pull request resolves, and include details of your solution. 8. One of our repository maintaners will review your pull request and will either merge it with the original repo, or request some changes. If changes are requested, go back to step 5 and proceed from there. diff --git a/docs/about/contributors.md b/docs/about/contributors.md new file mode 100644 index 00000000..1974b4a0 --- /dev/null +++ b/docs/about/contributors.md @@ -0,0 +1,5 @@ +--- +id: contributors +custom_edit_url: null +--- +# Contributors \ No newline at end of file From 04e314a1a1eff2537c52d99c6e45c44607d64cc9 Mon Sep 17 00:00:00 2001 From: Daniel Shown Date: Fri, 20 Oct 2023 13:40:23 -0500 Subject: [PATCH 2/5] fixups after local testing --- docs/about/community.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/about/community.md b/docs/about/community.md index b94ebe47..9a94248a 100644 --- a/docs/about/community.md +++ b/docs/about/community.md @@ -9,7 +9,7 @@ custom_edit_url: null We welcome the participation of anyone interested in contributing to the projects in our portfolio. You can work on open issues on projects in our portfolio, create a new issue, or e-mail us if you want to be more involved. -Join the conversation in the Open Sourc with SLU [Slack workspace](https://join.slack.com/t/oswslu/shared_invite/zt-24f0qhjbo-NkSfQ4LOg5wXxBdxP4vzfA) +Join the conversation in the Open Source with SLU [Slack workspace](https://join.slack.com/t/oswslu/shared_invite/zt-24f0qhjbo-NkSfQ4LOg5wXxBdxP4vzfA). ## Overview @@ -20,7 +20,7 @@ Join the conversation in the Open Sourc with SLU [Slack workspace](https://join. ## Getting Startted -Anyone interested in getting involved with Open Source with SLU projects can sign up by opening a [Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on the [contributors](contributors.md) page in this website. The PR will be merged when it includes a link to a merged ticket from a project in the [portfolio](../portfoliio.md) that they made contribution to, and the PR has been approved by the current tech lead on that project. +Anyone interested in getting involved with Open Source with SLU projects can sign up by opening a [Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on the [contributors](contributors.md) page in this website. The PR will be merged when it includes a link to a merged ticket from a project in the [portfolio](../portfolio.md) that they made contribution to, and the PR has been approved by the current tech lead on that project. ## Git From 60ed119ba8a62fa8c7401a7c0a446add82188a3f Mon Sep 17 00:00:00 2001 From: Daniel Shown Date: Thu, 2 Nov 2023 13:30:27 -0500 Subject: [PATCH 3/5] created more structure and clearer instructions around becoming a contributor --- .github/PULL_REQUEST_TEMPLATE/new_contributor.md | 15 +++++++++++++++ docs/about/community.md | 6 +++++- docs/about/contributors.md | 7 ++++++- 3 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/new_contributor.md diff --git a/.github/PULL_REQUEST_TEMPLATE/new_contributor.md b/.github/PULL_REQUEST_TEMPLATE/new_contributor.md new file mode 100644 index 00000000..f6101216 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/new_contributor.md @@ -0,0 +1,15 @@ +--- +name: New Contributor +about: Template to add someone as a new contributor. +title: "[DATE]: [FEATURE NAME]" +labels: contributor, needs triage +assignees: octocat +--- + +We are excited you want to [become an Open Source with SLU contributor](#21). The success of our projects depends on active involvement. If you want to be recognized as a contributor: + +- [ ] Add your name to the list in `docs/about/contributors.md`; + - Each entry must include a name; + - Each entry may optionally include a link to a GitHub user profile; + - Add your entry to the end of the list. +- [ ] Add a link to merged Pull Request or a closed Issue in an OSS [project](https://oss-slu.github.io/docs/portfolio) to this Pull Request. You can use the autolinked references formats for [issues and pull requests](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests). \ No newline at end of file diff --git a/docs/about/community.md b/docs/about/community.md index 9a94248a..50efb105 100644 --- a/docs/about/community.md +++ b/docs/about/community.md @@ -20,8 +20,12 @@ Join the conversation in the Open Source with SLU [Slack workspace](https://join ## Getting Startted -Anyone interested in getting involved with Open Source with SLU projects can sign up by opening a [Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on the [contributors](contributors.md) page in this website. The PR will be merged when it includes a link to a merged ticket from a project in the [portfolio](../portfolio.md) that they made contribution to, and the PR has been approved by the current tech lead on that project. +Anyone interested in getting involved with Open Source with SLU projects can sign up by opening a [Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on the [contributors](contributors.md) page in this website. The PR will be merged when the Pull Request includes a link to a merged ticket from a project in the [portfolio](../portfolio.md) that they made contribution to, and the PR has been approved by the current tech lead on that project. +## Join the `oss-slu` Team + +After making five contributions, you can be added to the `oss-slu` team in GitHub by contacting one of the program staff. Send an e-mail to or a slack message to the current Tech Lead on the project(s) you made contributions to. Include a list of at least five closed Issues and/or merged Pull Requests that you worked on. + ## Git All our projects are stored in public GitHub repositories. To make code contributions to our repositories, you will need to know the basics about Git and GitHub. We recommend this [video tutorial]("https://youtu.be/RGOj5yH7evk"), if you are not familiar with these tools. diff --git a/docs/about/contributors.md b/docs/about/contributors.md index 1974b4a0..919f375f 100644 --- a/docs/about/contributors.md +++ b/docs/about/contributors.md @@ -2,4 +2,9 @@ id: contributors custom_edit_url: null --- -# Contributors \ No newline at end of file +# Contributors + +These people have contributed to Open Source with SLU projects. They have been added in (approximately) the order in which they became contributors. + +- [Kate Holdener, Ph.D](https://github.com/kate-holdener) +- [Daniel Shown](https://github.com/kungfuchicken) \ No newline at end of file From 308128bbb2ae9ecca89fd4c39518622bb0bad178 Mon Sep 17 00:00:00 2001 From: Daniel Shown Date: Wed, 15 Nov 2023 10:40:27 -0600 Subject: [PATCH 4/5] more detailed instructions --- docs/about/community.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/about/community.md b/docs/about/community.md index 50efb105..2cb64963 100644 --- a/docs/about/community.md +++ b/docs/about/community.md @@ -20,7 +20,15 @@ Join the conversation in the Open Source with SLU [Slack workspace](https://join ## Getting Startted -Anyone interested in getting involved with Open Source with SLU projects can sign up by opening a [Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on the [contributors](contributors.md) page in this website. The PR will be merged when the Pull Request includes a link to a merged ticket from a project in the [portfolio](../portfolio.md) that they made contribution to, and the PR has been approved by the current tech lead on that project. +The success of our projects depends on active involvement. Anyone interested in getting involved with Open Source with SLU projects can sign up by opening a [Pull Request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on the [contributors](contributors.md) page in this website. The PR will be merged when the Pull Request includes a link to a merged ticket from a project in the [portfolio](../portfolio.md) that they made contribution to, and the PR has been approved by the current tech lead on that project. + +If you want to be recognized as a contributor, your pull request should include your name and a link to the work you have completed on an Open Source with SLU project. + +* [ ] Add your name to the list in `docs/about/contributors.md`; + * Each entry must include a name; + * Each entry may optionally include a link to a GitHub user profile; + * Add your entry to the end of the list. +* [ ] Add a link to an already merged Pull Request or a closed Issue in an OSS [project](https://oss-slu.github.io/docs/portfolio) to your Pull Request. You can use the autolinked references formats for [issues and pull requests](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests). ## Join the `oss-slu` Team From 7029202587b7267a3eab64496a2c8e727e50fc09 Mon Sep 17 00:00:00 2001 From: Daniel Shown Date: Wed, 15 Nov 2023 15:07:31 -0600 Subject: [PATCH 5/5] absolute URLs cannot use quotes --- docs/about/community.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/about/community.md b/docs/about/community.md index 2cb64963..218170b1 100644 --- a/docs/about/community.md +++ b/docs/about/community.md @@ -36,17 +36,17 @@ After making five contributions, you can be added to the `oss-slu` team in GitHu ## Git -All our projects are stored in public GitHub repositories. To make code contributions to our repositories, you will need to know the basics about Git and GitHub. We recommend this [video tutorial]("https://youtu.be/RGOj5yH7evk"), if you are not familiar with these tools. +All our projects are stored in public GitHub repositories. To make code contributions to our repositories, you will need to know the basics about Git and GitHub. We recommend this [video tutorial](https://youtu.be/RGOj5yH7evk), if you are not familiar with these tools. ## Guidance When you are ready to contribute code to one of our open-source project, here is the process you should follow: 1. Identify the issue you want to work on and post a comment in this issue, asking the repo maintainer to assign the issue to you. -2. Crate a fork of our repository. Here is GitHub documentation for how to [create a fork]("https://docs.github.com/en/enterprise-cloud@latest/get-started/quickstart/fork-a-repo") -3. Clone your fork of the repository. Here is GitHub documentation for how to clone [a repository]("https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository"). +2. Crate a fork of our repository. Here is GitHub documentation for how to [create a fork](https://docs.github.com/en/enterprise-cloud@latest/get-started/quickstart/fork-a-repo) +3. Clone your fork of the repository. Here is GitHub documentation for how to clone [a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). 4. Follow the developer guide to install project dependencies and run the code. 5. Make the necessary code changes to resolve the issue. Commit and push your changes frequently. Use meaningful commit messages when committing your code. 6. Test your changes, verifying that the issue is resolved. -7. Create a pull request - a request to merge changes from your fork of the repository to the original repository. Here is GitHub documentation for how to [create a pull request]("https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork"). Make sure to note the issue number that your pull request resolves, and include details of your solution. +7. Create a pull request - a request to merge changes from your fork of the repository to the original repository. Here is GitHub documentation for how to [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). Make sure to note the issue number that your pull request resolves, and include details of your solution. 8. One of our repository maintaners will review your pull request and will either merge it with the original repo, or request some changes. If changes are requested, go back to step 5 and proceed from there.