From 7fb8b70578b673d1976177162877b004a35ecb71 Mon Sep 17 00:00:00 2001 From: Eden Zimbelman Date: Thu, 20 Nov 2025 22:38:27 -0800 Subject: [PATCH 1/2] chore: encourage contribution and discussion through issue discussion and pull requests --- .github/CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..8c274a9 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributors Guide + +Interested in contributing? Awesome! Before you do though, please read our [Code of Conduct](https://github.com/slack-samples/bolt-java-examples/blob/main/.github/CODE_OF_CONDUCT.md). 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: + +- If you find a bug, please search for it in the [Issues](https://github.com/slack-samples/bolt-java-examples/issues), and if it isn't already tracked, [create a new issue](https://github.com/slack-samples/bolt-java-examples/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`. +- Issues that are related to the examples apps will be labelled `area:examples`. +- 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/slack-samples/bolt-java-examples/issues/new). +- Issues that have been identified as a feature request will be labelled `enhancement`. +- Issues that are related to the examples apps will be labelled `area:examples`. +- 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/slack-samples/bolt-java-examples/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.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. + +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. From b00f3068f81379d02fc3ea97fe0bbf25d67cbbc5 Mon Sep 17 00:00:00 2001 From: Eden Zimbelman Date: Thu, 20 Nov 2025 22:43:20 -0800 Subject: [PATCH 2/2] fix: update links to be python --- .github/CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8c274a9..32533c6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,12 +1,12 @@ # Contributors Guide -Interested in contributing? Awesome! Before you do though, please read our [Code of Conduct](https://github.com/slack-samples/bolt-java-examples/blob/main/.github/CODE_OF_CONDUCT.md). We take it very seriously, and expect that you will as well. +Interested in contributing? Awesome! Before you do though, please read our [Code of Conduct](https://github.com/slack-samples/bolt-python-examples/blob/main/.github/CODE_OF_CONDUCT.md). 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: -- If you find a bug, please search for it in the [Issues](https://github.com/slack-samples/bolt-java-examples/issues), and if it isn't already tracked, [create a new issue](https://github.com/slack-samples/bolt-java-examples/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. +- If you find a bug, please search for it in the [Issues](https://github.com/slack-samples/bolt-python-examples/issues), and if it isn't already tracked, [create a new issue](https://github.com/slack-samples/bolt-python-examples/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`. - Issues that are related to the examples apps will be labelled `area:examples`. - If you'd like to submit a fix for a bug, [send a Pull Request](#creating-a-pull-request) and mention the Issue number. @@ -14,7 +14,7 @@ There are many ways you can contribute! :heart: ### 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/slack-samples/bolt-java-examples/issues/new). +- 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/slack-samples/bolt-python-examples/issues/new). - Issues that have been identified as a feature request will be labelled `enhancement`. - Issues that are related to the examples apps will be labelled `area:examples`. - 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. @@ -23,7 +23,7 @@ There are many ways you can contribute! :heart: - 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/slack-samples/bolt-java-examples/issues/new) to discuss the idea first. +- If not, [open an Issue](https://github.com/slack-samples/bolt-python-examples/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`.