From 00404e13003bbc4ece56a874e661eedeee817cf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 16 Jan 2025 07:49:32 +0100 Subject: [PATCH 1/7] Remove links from bundler issue template The first time you open an issue, you'll get redirected to the CONNTRIBUTING.md file first, where you have the opportunity to read all the documentation. I don't think it's helpful to include links in the template because they are not even clickable. Users would need to copy-paste the link to the address bar of their browser. I think most people will not do that so I believe it's better to show them the different sections and their description right away. This "fixes" some broken links as a side effect. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index ae5e56d5c677..ba29d613452f 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -9,15 +9,9 @@ assignees: '' @@ -53,7 +47,7 @@ Fill this with a list of steps maintainers can follow to reproduce your issue. N The more complete the steps to simulate your particular environment are, the easier it will be for maintainers to reproduce your issue on their machines. -Ideally, we recommend you set up the list of steps as a [Dockerfile](https://docs.docker.com/get-started/). A Dockerfile provides a neutral environment that should give the same results, no matter where it's run. +Ideally, we recommend you set up the list of steps as a Dockerfile. A Dockerfile provides a neutral environment that should give the same results, no matter where it's run. --> From cc03d6e086ad7b522fedc56f729eee31e1c0bd4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 16 Jan 2025 07:59:18 +0100 Subject: [PATCH 2/7] Remove CoC link from pull request template GitHub UI already provides a link to our CoC, and that one is actually clickable. --- .github/pull_request_template.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 96a3df16bd59..102f2f9c1146 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,6 @@ From c360c9a0e7a060a79d45724fac812e0f513e4772 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 16 Jan 2025 08:00:02 +0100 Subject: [PATCH 3/7] Fix broken link in pull request template --- .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 102f2f9c1146..fafe9a21f2d5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,6 +17,6 @@ alternatives, explain why you end up choosing the current implementation --> ## Make sure the following tasks are checked - [ ] Describe the problem / feature -- [ ] Write [tests](https://github.com/rubygems/rubygems/blob/master/bundler/doc/development/PULL_REQUESTS.md#tests) for features and bug fixes +- [ ] Write [tests](https://github.com/rubygems/rubygems/blob/master/doc/bundler/development/PULL_REQUESTS.md#tests) for features and bug fixes - [ ] Write code to solve the problem - [ ] Make sure you follow the [current code style](https://github.com/rubygems/rubygems/blob/master/doc/bundler/development/PULL_REQUESTS.md#code-formatting) and [write meaningful commit messages without tags](https://github.com/rubygems/rubygems/blob/master/doc/bundler/development/PULL_REQUESTS.md#commit-messages) From 2f36fd86b3f804d47b5d18c3a1d3f7554d37992c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 16 Jan 2025 08:03:28 +0100 Subject: [PATCH 4/7] Fix broken link in bundler README --- bundler/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bundler/README.md b/bundler/README.md index 002cd7c9a389..d922266c440d 100644 --- a/bundler/README.md +++ b/bundler/README.md @@ -41,7 +41,7 @@ To get in touch with the Bundler core team and other Bundler users, please join ### Contributing -If you'd like to contribute to Bundler, that's awesome, and we <3 you. We've put together [the Bundler contributor guide](https://github.com/rubygems/rubygems/blob/master/bundler/doc/contributing/README.md) with all of the information you need to get started. +If you'd like to contribute to Bundler, that's awesome, and we <3 you. We've put together [the Bundler contributor guide](https://github.com/rubygems/rubygems/blob/master/doc/bundler/contributing/README.md) with all of the information you need to get started. If you'd like to request a substantial change to Bundler or its documentation, refer to the [Bundler RFC process](https://github.com/rubygems/rfcs) for more information. From 0909f07f30391e29c8fa395b023ecf5c91d9f77b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 16 Jan 2025 08:03:58 +0100 Subject: [PATCH 5/7] Fix broken link in `bundle issue` output --- bundler/lib/bundler/cli/issue.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bundler/lib/bundler/cli/issue.rb b/bundler/lib/bundler/cli/issue.rb index 5f2924c4bdb5..e16c9b0e39ff 100644 --- a/bundler/lib/bundler/cli/issue.rb +++ b/bundler/lib/bundler/cli/issue.rb @@ -10,7 +10,7 @@ def run be sure to check out these resources: 1. Check out our troubleshooting guide for quick fixes to common issues: - https://github.com/rubygems/rubygems/blob/master/bundler/doc/TROUBLESHOOTING.md + https://github.com/rubygems/rubygems/blob/master/doc/bundler/TROUBLESHOOTING.md 2. Instructions for common Bundler uses can be found on the documentation site: https://bundler.io/ From 7b9bee16da8dbf6ee4b44e6b2ebdf4e78d9b8677 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 16 Jan 2025 08:04:53 +0100 Subject: [PATCH 6/7] Fix broken links in CONTRIBUTING readme --- doc/bundler/contributing/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/bundler/contributing/README.md b/doc/bundler/contributing/README.md index aebd17b3452e..21c13eccc563 100644 --- a/doc/bundler/contributing/README.md +++ b/doc/bundler/contributing/README.md @@ -5,9 +5,9 @@ Thank you for your interest in making Bundler better! We welcome contributions f Before submitting a contribution, read through the following guidelines: * [Bundler Code of Conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md) (By participating in Bundler, you agree to abide by the terms laid out in the CoC.) -* [Pull Request Guidelines](https://github.com/rubygems/rubygems/blob/master/bundler/doc/development/PULL_REQUESTS.md) +* [Pull Request Guidelines](../development/PULL_REQUESTS.md) -And be sure to [set up your development environment](https://github.com/rubygems/rubygems/blob/master/bundler/doc/development/SETUP.md). +And be sure to [set up your development environment](../development/SETUP.md). ## Feature Requests From a941dfc5f6d0271acf553e34a564f1c527e19e26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 16 Jan 2025 08:05:27 +0100 Subject: [PATCH 7/7] Fix broken links in TEAM_CHANGES document --- doc/bundler/playbooks/TEAM_CHANGES.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/bundler/playbooks/TEAM_CHANGES.md b/doc/bundler/playbooks/TEAM_CHANGES.md index 865719d53684..a4dd0cf49331 100644 --- a/doc/bundler/playbooks/TEAM_CHANGES.md +++ b/doc/bundler/playbooks/TEAM_CHANGES.md @@ -1,6 +1,6 @@ # Team changes -This file documents how to add and remove team members. For the rules governing adding and removing team members, see [POLICIES][policies]. +This file documents how to add and remove team members. For the rules governing adding and removing team members, see [POLICIES](../POLICIES.md). ## Adding a new team member @@ -9,7 +9,7 @@ Interested in adding someone to the team? Here's the process. 1. An existing team member nominates a potential team member to the rest of the team. 2. The existing team reaches consensus about whether to invite the potential member. 3. The nominator asks the potential member if they would like to join the team. -4. The nominator also sends the candidate a link to [POLICIES][policies] as an orientation for being on the team. +4. The nominator also sends the candidate a link to [POLICIES](../POLICIES.md) as an orientation for being on the team. 5. If the potential member accepts: - Invite them to the maintainers Slack channel - Add them to the [maintainers team][org_team] on GitHub @@ -24,7 +24,7 @@ Interested in adding someone to the team? Here's the process. ## Removing a team member -When the conditions in [POLICIES](https://github.com/rubygems/rubygems/blob/master/bundler/doc/POLICIES.md#maintainer-team-guidelines) are met, or when team members choose to retire, here's how to remove someone from the team. +When the conditions in [POLICIES](../POLICIES.md#maintainer-team-guidelines) are met, or when team members choose to retire, here's how to remove someone from the team. - Remove them from the owners list on RubyGems.org by running ``` @@ -35,7 +35,6 @@ When the conditions in [POLICIES](https://github.com/rubygems/rubygems/blob/mast - Remove them from the [maintainers team][org_team] on GitHub - Remove them from the maintainers Slack channel -[policies]: https://github.com/rubygems/rubygems/blob/master/bundler/doc/POLICIES.md#bundler-policies [org_team]: https://github.com/orgs/rubygems/teams/maintainers/members [team]: https://bundler.io/contributors.html [maintainers]: https://github.com/rubygems/bundler-site/blob/f00eb65da0697c2cb0e7b4d6e5ba47ecc1538eb2/source/contributors.html.haml#L25