Repository navigation
feat: add blank bolt for python template #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Salesforce Open Source project configuration | ||
| # Learn more: https://github.com/salesforce/oss-template | ||
| #ECCN:Open Source | ||
| #GUSINFO:Slack Developer Experience,Open Source | ||
|
|
||
| # Code owners are the default owners for everything in | ||
| # this repository. The owners listed below will be requested for | ||
| # review when a pull request is opened. | ||
| # To set code owner(s), replace the team below with either | ||
| # their GitHub username(s) or a GitHub team. | ||
| * @slack-samples/maintainers | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # Salesforce Open Source Community Code of Conduct | ||
|
|
||
| ## About the Code of Conduct | ||
|
|
||
| Equality is a core value at Salesforce. We believe a diverse and inclusive | ||
| community fosters innovation and creativity, and are committed to building a | ||
| culture where everyone feels included. | ||
|
|
||
| Salesforce open-source projects are committed to providing a friendly, safe, and | ||
| welcoming environment for all, regardless of gender identity and expression, | ||
| sexual orientation, disability, physical appearance, body size, ethnicity, nationality, | ||
| race, age, religion, level of experience, education, socioeconomic status, or | ||
| other similar personal characteristics. | ||
|
|
||
| The goal of this code of conduct is to specify a baseline standard of behavior so | ||
| that people with different social values and communication styles can work | ||
| together effectively, productively, and respectfully in our open source community. | ||
| It also establishes a mechanism for reporting issues and resolving conflicts. | ||
|
|
||
| All questions and reports of abusive, harassing, or otherwise unacceptable behavior | ||
| in a Salesforce open-source project may be reported by contacting the Salesforce | ||
| Open Source Conduct Committee at ossconduct@salesforce.com. | ||
|
|
||
| ## Our Pledge | ||
|
|
||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making participation in our project and | ||
| our community a harassment-free experience for everyone, regardless of gender | ||
| identity and expression, sexual orientation, disability, physical appearance, | ||
| body size, ethnicity, nationality, race, age, religion, level of experience, education, | ||
| socioeconomic status, or other similar personal characteristics. | ||
|
|
||
| ## Our Standards | ||
|
|
||
| Examples of behavior that contributes to creating a positive environment | ||
| include: | ||
|
|
||
| * Using welcoming and inclusive language | ||
| * Being respectful of differing viewpoints and experiences | ||
| * Gracefully accepting constructive criticism | ||
| * Focusing on what is best for the community | ||
| * Showing empathy toward other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or | ||
| advances | ||
| * Personal attacks, insulting/derogatory comments, or trolling | ||
| * Public or private harassment | ||
| * Publishing, or threatening to publish, others' private information—such as | ||
| a physical or electronic address—without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
| * Advocating for or encouraging any of the above behaviors | ||
|
|
||
| ## Our Responsibilities | ||
|
|
||
| Project maintainers are responsible for clarifying the standards of acceptable | ||
| behavior and are expected to take appropriate and fair corrective action in | ||
| response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or | ||
| reject comments, commits, code, wiki edits, issues, and other contributions | ||
| that are not aligned with this Code of Conduct, or to ban temporarily or | ||
| permanently any contributor for other behaviors that they deem inappropriate, | ||
| threatening, offensive, or harmful. | ||
|
|
||
| ## Scope | ||
|
|
||
| This Code of Conduct applies both within project spaces and in public spaces | ||
| when an individual is representing the project or its community. Examples of | ||
| representing a project or community include using an official project email | ||
| address, posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. Representation of a project may be | ||
| further defined and clarified by project maintainers. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the Salesforce Open Source Conduct Committee | ||
| at ossconduct@salesforce.com. All complaints will be reviewed and investigated | ||
| and will result in a response that is deemed necessary and appropriate to the | ||
| circumstances. The committee is obligated to maintain confidentiality with | ||
| regard to the reporter of an incident. Further details of specific enforcement | ||
| policies may be posted separately. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good | ||
| faith may face temporary or permanent repercussions as determined by other | ||
| members of the project's leadership and the Salesforce Open Source Conduct | ||
| Committee. | ||
|
|
||
| ## Attribution | ||
|
|
||
| This Code of Conduct is adapted from the [Contributor Covenant][contributor-covenant-home], | ||
| version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html. | ||
| It includes adaptations and additions from [Go Community Code of Conduct][golang-coc], | ||
| [CNCF Code of Conduct][cncf-coc], and [Microsoft Open Source Code of Conduct][microsoft-coc]. | ||
|
|
||
| This Code of Conduct is licensed under the [Creative Commons Attribution 3.0 License][cc-by-3-us]. | ||
|
|
||
| [contributor-covenant-home]: https://www.contributor-covenant.org | ||
| [golang-coc]: https://golang.org/conduct | ||
| [cncf-coc]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md | ||
| [microsoft-coc]: https://opensource.microsoft.com/codeofconduct/ | ||
| [cc-by-3-us]: https://creativecommons.org/licenses/by/3.0/us/ |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # Contributors Guide | ||
|
|
||
| Interested in contributing? Awesome! Before you do though, please read our [Code of Conduct](https://github.com/slack-samples/bolt-python-blank-template/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-python-blank-template/issues), and if it isn't already tracked, [create a new issue](https://github.com/slack-samples/bolt-python-blank-template/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/slack-samples/bolt-python-blank-template/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/slack-samples/bolt-python-blank-template/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 issue`. | ||
|
|
||
| ## 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. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| ## Security | ||
|
|
||
| Please report any security issue to [https://www.sfdc.co/SubmitVuln](https://www.sfdc.co/SubmitVuln) | ||
| as soon as it is discovered. This project limits its runtime dependencies in | ||
| order to reduce the total cost of ownership as much as can be, but all consumers | ||
| should remain vigilant and have their security stakeholders review all third-party | ||
| products (3PP) like this one and their dependencies. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "monthly" | ||
| cooldown: | ||
| default-days: 7 | ||
| - package-ecosystem: "pip" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "monthly" | ||
| cooldown: | ||
| default-days: 7 | ||
| exclude: | ||
| - "slack*" | ||
| labels: | ||
| - "pip" | ||
| - "dependencies" |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: Merge updates to dependencies | ||
| on: | ||
| pull_request: | ||
| jobs: | ||
| dependabot: | ||
| name: "@dependabot" | ||
| if: github.event.pull_request.user.login == 'dependabot[bot]' | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| steps: | ||
| - name: Collect metadata | ||
| id: metadata | ||
| uses: dependabot/fetch-metadata@25dd0e34f4fe68f24cc83900b1fe3fe149efef98 # v3.1.0 | ||
| with: | ||
| github-token: "${{ secrets.GITHUB_TOKEN }}" | ||
| - name: Approve | ||
| if: steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor' | ||
| run: gh pr review --approve "$PR_URL" | ||
| env: | ||
| PR_URL: ${{github.event.pull_request.html_url}} | ||
| GH_TOKEN: ${{secrets.GITHUB_TOKEN}} | ||
| - name: Automerge | ||
| if: steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor' | ||
| run: gh pr merge --auto --squash "$PR_URL" | ||
| env: | ||
| PR_URL: ${{ github.event.pull_request.html_url }} | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,40 @@ | ||||||||||||||||||||
| name: Lint | ||||||||||||||||||||
|
|
||||||||||||||||||||
| on: | ||||||||||||||||||||
| push: | ||||||||||||||||||||
| branches: | ||||||||||||||||||||
| - main | ||||||||||||||||||||
| pull_request: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| permissions: | ||||||||||||||||||||
| contents: read | ||||||||||||||||||||
|
|
||||||||||||||||||||
| jobs: | ||||||||||||||||||||
|
Comment on lines
+7
to
+12
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🐙 suggestion: We can scope the token to read only here since lint doesn't write anything. zizmor flags the default permissions otherwise.
Suggested change
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Applied in 672e026, thanks! 🙇 |
||||||||||||||||||||
| lint: | ||||||||||||||||||||
| runs-on: ubuntu-latest | ||||||||||||||||||||
| timeout-minutes: 5 | ||||||||||||||||||||
| strategy: | ||||||||||||||||||||
| fail-fast: false | ||||||||||||||||||||
| matrix: | ||||||||||||||||||||
| python-version: | ||||||||||||||||||||
| - "3.11" | ||||||||||||||||||||
| - "3.12" | ||||||||||||||||||||
| - "3.13" | ||||||||||||||||||||
| - "3.14" | ||||||||||||||||||||
| - "3.15" | ||||||||||||||||||||
| steps: | ||||||||||||||||||||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||||||||||||||||||||
| with: | ||||||||||||||||||||
| persist-credentials: false | ||||||||||||||||||||
| - name: Set up Python ${{ matrix.python-version }} | ||||||||||||||||||||
| uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0 | ||||||||||||||||||||
| with: | ||||||||||||||||||||
| python-version: ${{ matrix.python-version }} | ||||||||||||||||||||
| - name: Install dependencies | ||||||||||||||||||||
| run: | | ||||||||||||||||||||
| pip install -U pip | ||||||||||||||||||||
| pip install -e ".[dev]" | ||||||||||||||||||||
| - name: Lint and check formatting | ||||||||||||||||||||
| run: | | ||||||||||||||||||||
| ruff check . | ||||||||||||||||||||
| ruff format --check . | ||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # general things to ignore | ||
| build/ | ||
| dist/ | ||
| docs/_sources/ | ||
| docs/.doctrees | ||
| .eggs/ | ||
| *.egg-info/ | ||
| *.egg | ||
| *.py[cod] | ||
| __pycache__/ | ||
| *.so | ||
| *~ | ||
|
|
||
| # virtualenv | ||
| env*/ | ||
| venv/ | ||
| .venv* | ||
| .env* | ||
|
|
||
| # codecov / coverage | ||
| .coverage | ||
| cov_* | ||
| coverage.xml | ||
|
|
||
| # due to using tox and pytest | ||
| .tox | ||
| .cache | ||
| .pytest_cache/ | ||
| .python-version | ||
| pip | ||
| .mypy_cache/ | ||
|
|
||
| # misc | ||
| tmp.txt | ||
| .DS_Store | ||
| logs/ | ||
| *.db | ||
| .pytype/ | ||
| .idea/ |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # AGENTS.md | ||
|
|
||
| This file provides guidance to coding agents when working with code in this repository. | ||
|
|
||
| ## What This Is | ||
|
|
||
| A blank Bolt for Python template app used to start building new Slack apps. | ||
|
|
||
| ## Slack Plugin | ||
|
|
||
| To install the Slack plugin for your coding agent, follow [Claude Code, Codex, Cursor, and Other Coding Agents](./README.md#claude-code-codex-cursor-and-other-coding-agents) in the README. | ||
|
|
||
| ## Before you finish | ||
|
|
||
| Run `ruff check .` and `ruff format --check .`. CI runs the same on every PR. | ||
|
|
||
| ## Code Style | ||
|
|
||
| - Snake-case filenames | ||
| - No code comments. Make the code explain itself with clear names, tests, or types. Put the reason for a change in the PR description. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| @AGENTS.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note:
Slack Developer Experience⚒️