Improve the contribution guidelines (#86)

slackapi · Sep 20, 2023 · 7476afc · 7476afc
1 parent 368e406
commit 7476afc
Show file tree

Hide file tree

Showing 9 changed files with 259 additions and 147 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,63 +1,82 @@
 # Contributors Guide
 
 Interested in contributing? Awesome! Before you do though, please read our
-[Code of Conduct](https://slackhq.github.io/code-of-conduct). We take it very seriously, and expect that you will as
-well.
+[Code of Conduct](https://slackhq.github.io/code-of-conduct). We take it very
+seriously, and expect that you will as well.
 
 There are many ways you can contribute! :heart:
 
-### Bug Reports and Fixes :bug:
-- At this early stage of development we are not accepting bug reports or feature requests through GitHub. Yet.
-<!--
--  If you find a bug, please search for it in the [Issues](https://github.com/slackapi/deno-slack-api/issues), and if it isn't already tracked,
-   [create a new issue](https://github.com/slackapi/deno-slack-api/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
-   be reviewed.
--  Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
--  If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
-  -  Include tests that isolate the bug and verifies that it was fixed.
-
-### New Features :bulb:
--  If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/slackapi/deno-slack-api/issues/new).
--  Issues that have been identified as a feature request will be labelled `enhancement`.
--  If you'd like to implement the new feature, please wait for feedback from the project
-   maintainers before spending too much time writing the code. In some cases, `enhancement`s may
-   not align well with the project objectives at the time.
-
-### Tests :mag:, Documentation :books:, Miscellaneous :sparkles:
--  If you'd like to improve the tests, you want to make the documentation clearer, you have an
-   alternative implementation of something that may have advantages over the way its currently
-   done, or you have any other change, we would be happy to hear about it!
-  -  If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
-  -  If not, [open an Issue](https://github.com/slackapi/deno-slack-api/issues/new) to discuss the idea first.
-
-If you're new to our project and looking for some way to make your first contribution, look for
-Issues labelled `good first contribution`.
--->
+## :bug: Bug Reports and Fixes
+
+- If you find a bug, please search for it in the
+  [Issues](https://github.com/slackapi/deno-slack-api/issues), and if it isn't
+  already tracked,
+  [create a new Bug Report Issue](https://github.com/slackapi/deno-slack-api/issues/new/choose).
+  Fill out the "Bug Report" section of the issue template. Even if an Issue is
+  closed, feel free to comment and add details, it will still be reviewed.
+- Issues that have already been identified as a bug (note: able to reproduce)
+  will be labelled `bug`.
+- If you'd like to submit a fix for a bug,
+  [send a Pull Request](#creating-a-pull-request) and mention the Issue number.
+- Include tests that isolate the bug and verifies that it was fixed.
+
+## :bulb: New Features
+
+- If you'd like to add new functionality to this project, describe the problem
+  you want to solve in a
+  [new Feature Request Issue](https://github.com/slackapi/deno-slack-api/issues/new/choose).
+- Issues that have been identified as a feature request will be labelled
+  `enhancement`.
+- If you'd like to implement the new feature, please wait for feedback from the
+  project maintainers before spending too much time writing the code. In some
+  cases, `enhancement`s may not align well with the project objectives at the
+  time.
+
+## :mag: Tests, :books: Documentation,:sparkles: Miscellaneous
+
+- If you'd like to improve the tests, you want to make the documentation
+  clearer, you have an alternative implementation of something that may have
+  advantages over the way its currently done, or you have any other change, we
+  would be happy to hear about it!
+- If its a trivial change, go ahead and
+  [send a Pull Request](#creating-a-pull-request) with the changes you have in
+  mind.
+- If not, [open an Issue](https://github.com/slackapi/deno-slack-api/issues/new)
+  to discuss the idea first.
+
+If you're new to our project and looking for some way to make your first
+contribution, look for Issues labelled `good first contribution`.
 
 ## Requirements
 
 For your contribution to be accepted:
 
-- [x] You must have signed the [Contributor License Agreement (CLA)](https://cla-assistant.io/slackapi/deno-slack-api).
+- [x] You must have signed the
+      [Contributor License Agreement (CLA)](https://cla.salesforce.com/sign-cla).
 - [x] The test suite must be complete and pass.
 - [x] The changes must be approved by code review.
-- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
+- [x] Commits should be atomic and messages must be descriptive. Related issues
+      should be mentioned by Issue number.
 
-If the contribution doesn't meet the above criteria, you may fail our automated checks or a maintainer will discuss it with you. You can continue to improve a Pull Request by adding commits to the branch from which the PR was created.
+If the contribution doesn't meet the above criteria, you may fail our automated
+checks or a maintainer will discuss it with you. You can continue to improve a
+Pull Request by adding commits to the branch from which the PR was created.
 
 [Interested in knowing more about about pull requests at Slack?](https://slack.engineering/on-empathy-pull-requests-979e4257d158#.awxtvmb2z)
 
 ## Creating a Pull Request
 
-1.  :fork_and_knife: Fork the repository on GitHub.
-2.  :runner: Clone/fetch your fork to your local development machine. It's a good idea to run the tests just
-    to make sure everything is in order.
-3.  :herb: Create a new branch and check it out.
-4.  :crystal_ball: Make your changes and commit them locally. Magic happens here!
-5.  :arrow_heading_up: Push your new branch to your fork. (e.g. `git push username fix-issue-16`).
-6.  :inbox_tray: Open a Pull Request on github.com from your new branch on your fork to `main` in this
-    repository.
+1. :fork_and_knife: Fork the repository on GitHub.
+2. :runner: Clone/fetch your fork to your local development machine. It's a good
+   idea to run the tests just to make sure everything is in order.
+3. :herb: Create a new branch and check it out.
+4. :crystal_ball: Make your changes and commit them locally. Magic happens here!
+5. :arrow_heading_up: Push your new branch to your fork. (e.g.
+   `git push username fix-issue-16`).
+6. :inbox_tray: Open a Pull Request on github.com from your new branch on your
+   fork to `main` in this repository.
 
 ## Maintainers
 
-There are more details about processes and workflow in the [Maintainer's Guide](./maintainers_guide.md).
+There are more details about processes and workflow in the
+[Maintainer's Guide](./maintainers_guide.md).
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,42 @@
+---
+name: Bug Report
+about: Report a bug encountered while using this project
+title: '[BUG] <title>'
+---
+
+<!-- If you find a bug, please search for it in the [Issues](https://github.com/slackapi/deno-slack-api/issues), and if it isn't already tracked then create a new issue -->
+
+**The `deno-slack` versions**
+
+<!-- Paste the output of `cat import_map.json | grep deno-slack` -->
+
+**Deno runtime version**
+
+<!-- Paste the output of `deno --version` -->
+
+**OS info**
+
+<!-- Paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS -->
+
+**Describe the bug**
+
+<!-- A clear and concise description of what the bug is. -->
+
+**Steps to reproduce**
+
+<!-- Share the commands to run, source code, and project settings -->
+1.
+2.
+3.
+
+**Expected result**
+
+<!-- Tell what you expected to happen -->
+
+**Actual result**
+
+<!-- Tell what actually happened with logs, screenshots -->
+
+**Requirements**
+
+Please read the [Contributing guidelines](https://github.com/slackapi/deno-slack-api/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest a new feature for this project
+title: '[FEATURE] <title>'
+---
+
+<!-- If you have a feature request, please search for it in the [Issues](https://github.com/slackapi/deno-slack-api/issues), and if it isn't already tracked then create a new issue -->
+
+**Description of the problem being solved**
+
+<!-- Please describe the problem you want to solve -->
+
+**Alternative solutions**
+
+<!-- Please describe the solutions you've considered -->
+
+**Requirements**
+
+Please read the [Contributing guidelines](https://github.com/slackapi/deno-slack-api/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,26 @@
+---
+name: Question
+about: Ask a question about this project
+title: '[QUERY] <title>'
+label: question
+---
+
+<!-- If you have a question, please search for it in the [Issues](https://github.com/slackapi/deno-slack-api/issues), and if it isn't already tracked then create a new issue -->
+
+**Question**
+
+<!-- A clear and concise question with steps to reproduce -->
+
+**Context**
+
+<!-- Any additional context to your question -->
+
+**Environment**
+
+<!-- Paste the output of `cat import_map.json | grep deno-slack` -->
+<!-- Paste the output of `deno --version` -->
+<!-- Paste the output of `sw_vers && uname -v` on macOS/Linux or `ver` on Windows OS -->
+
+**Requirements**
+
+Please read the [Contributing guidelines](https://github.com/slackapi/deno-slack-api/blob/main/.github/contributing.md) and [Code of Conduct](https://slackhq.github.io/code-of-conduct) before creating this issue or pull request. By submitting, you are agreeing to those rules.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,8 +1,19 @@
-###  Summary
+<!--  Thanks for sending a pull request! -->
 
-Describe the goal of this PR. Mention any related Issue numbers.
+### Summary
 
-### Requirements (place an `x` in each `[ ]`)
+<!-- A high level description of the change that will make it easier for your reviewer to make sense of the changes -->
+
+### testing
+
+<!-- Describe what steps a reviewer should follow to test your changes. -->
+
+### Special notes
+
+<!-- Any special notes reviewers should be aware of. -->
+
+### Requirements <!-- place an `x` in each `[ ]` -->
 
 * [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/deno-slack-api/blob/main/.github/CONTRIBUTING.md) and have done my best effort to follow them.
 * [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
+* [ ] I've ran `deno task test` after making the changes.