Minor README fixes (#688)

* Minor README fixes 1. Fix lint errors in README 2. Remove dead link to slack channel Signed-off-by: Anish Asthana <[email protected]> * Remove stale slack link from issue template Signed-off-by: Anish Asthana <[email protected]> * Further membership issue template fixes 1. Remove the area/process label as it doesn't seem to exist in the repo. examples: #639 (comment), #689 (comment) 2. Improve structure of the issue template Signed-off-by: Anish Asthana <[email protected]> --------- Signed-off-by: Anish Asthana <[email protected]>
kubeflow · Jul 24, 2024 · b453144 · b453144
1 parent 96d15f0
commit b453144
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 17 deletions.
diff --git a/.github/ISSUE_TEMPLATE/join_org.md b/.github/ISSUE_TEMPLATE/join_org.md
@@ -4,29 +4,27 @@ about: Request to join or modify Kubeflow GitHub membership
 
 ---
 
-/kind area/process
+# Membership Request
 
-Please read the [guide lines](https://www.kubeflow.org/docs/about/contributing/#joining-the-community) for joining the Kubeflow GitHub org before opening an issue
+Please read the [guidelines](https://www.kubeflow.org/docs/about/contributing/#joining-the-community) for joining the Kubeflow GitHub org before opening an issue
 
 **Please provide links to PRs or other contributions (2-3):**
 
+**Please list 2 existing members who are sponsoring your membership:**
 
-** Please list 2 existing members who are sponsoring your membership:**
-
-** Please test your PR **
+## Please test your PR
 
 Run
 
-```
+```bash
 cd github_orgs
 pytest test_org_yaml.py
 ```
+
 Include the output in the PR
 
-**Additional Instructions**
+## Additional Instructions
 
-After your PR is merged please wait at least 1 hour for changes to propogate. 
+After your PR is merged please wait at least 1 hour for changes to propogate.
 
 If after an hour you haven't recieved an invite to join the GitHub org please open an issue.
-
-You can contact build copy in #buildcop in kubeflow.slack.com
diff --git a/README.md b/README.md
@@ -7,26 +7,24 @@ For Google Groups in kubeflow.org, refer to `google_groups` subfolder.
 Run `pytest` after modifying `org.yaml`. Currently, this must be run
 manually. This test run automatically in a future change.
 
-## Joining Kubeflow GitHub organization
+## Joining the Kubeflow GitHub organization
 
 To join the Kubeflow GitHub organization, complete the following steps:
 
-* Read the [guidelines for joining the Kubeflow GitHub org](https://www.kubeflow.org/docs/about/contributing/#joining-the-community)
-  before opening an issue.
+* Read the [guidelines for joining the Kubeflow GitHub org](https://www.kubeflow.org/docs/about/contributing/#joining-the-community) before opening an issue.
 * **Provide 2-3 links to PRs or other contributions.**
 * **List 2 existing members who are sponsoring your membership.**
 * **Test your PR by running the following:**
 
-  ```
+  ```bash
   cd github-orgs
   pytest test_org_yaml.py
   ```
+
   Include the output in the PR.
 
-**Additional Instructions**
+### Additional Instructions
 
 After your PR is merged, wait at least 1 hour for changes to propagate.
 If, after an hour, you haven't recieved an invite to join the Kubeflow
 GitHub org, open an issue.
-
-You can contact build cop in the #buildcop channel of [kubeflow.slack.com](https://kubeflow.slack.com).