Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

chore: welcome first-time contributors and surface the Slack invite (#1968)

Hector Venturaf36598244d0a
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000000..6ab29d7810
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,17 @@
+# Adds links to the "New issue" chooser alongside the bug/feature templates.
+# Keeps the Slack invite visible before someone files, without adding boilerplate
+# to every issue body.
+blank_issues_enabled: true
+
+contact_links:
+ - name: πŸ’¬ Floci Community on Slack
+ url: https://join.slack.com/t/floci/shared_invite/zt-3tjn02s3q-A00kEjJ1cZxsg_imTfy6Cw
+ about: Ask a question, talk through AWS behaviour or a design tradeoff, or get help before filing.
+
+ - name: πŸ—£οΈ GitHub Discussions
+ url: https://github.com/orgs/floci-io/discussions
+ about: Longer-form proposals, ideas, and open-ended questions.
+
+ - name: πŸ”’ Report a security vulnerability
+ url: https://github.com/floci-io/floci/security/advisories/new
+ about: Please do not open a public issue for security problems β€” report them privately here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 3e5cffb977..7d7f0d5461 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -19,3 +19,7 @@
- [ ] `./mvnw test` passes locally
- [ ] New or updated integration test added
- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
+
+<!-- First PR here? Your CI checks wait for a maintainer to approve them before they run β€” that's GitHub's gate on first-time contributors, not a problem with your PR. -->
+<!-- Questions, or want feedback on an approach before going further? Join us on Slack: https://join.slack.com/t/floci/shared_invite/zt-3tjn02s3q-A00kEjJ1cZxsg_imTfy6Cw -->
+
diff --git a/.github/workflows/welcome.yml b/.github/workflows/welcome.yml
new file mode 100644
index 0000000000..e6678a3b24
--- /dev/null
+++ b/.github/workflows/welcome.yml
@@ -0,0 +1,47 @@
+name: Welcome First-Time Contributors
+
+on:
+ issues:
+ types: [opened]
+ # pull_request_target so the token has write access on fork PRs, which is where
+ # first-time contributions come from. This workflow never checks out or executes
+ # PR code β€” it only posts a comment β€” so the elevated context is not exposed.
+ pull_request_target:
+ types: [opened]
+
+permissions:
+ issues: write
+ pull-requests: write
+
+jobs:
+ welcome:
+ name: Greet on first issue or PR
+ runs-on: ubuntu-latest
+
+ steps:
+ # Block scalars below are literal (|), not folded (>): folding joins Markdown
+ # bullets onto one line. One paragraph per line, because GitHub renders a
+ # single newline in a comment as a hard line break.
+ - uses: actions/[email protected]
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+ issue-message: |
+ πŸ‘‹ Thanks for opening your first issue in Floci!
+
+ A maintainer will triage this and add the right service label. If you included a minimal reproduction and the Floci version, that is everything we need β€” no action required from you right now.
+
+ Come say hi in [Slack](https://join.slack.com/t/floci/shared_invite/zt-3tjn02s3q-A00kEjJ1cZxsg_imTfy6Cw) if you want to talk it through with maintainers and other contributors. Questions about AWS behaviour, design tradeoffs, and rough proposals are all welcome there.
+
+ pr-message: |
+ πŸŽ‰ Thanks for your first pull request to Floci!
+
+ **Your CI checks need a maintainer to approve them before they run.** That is GitHub's standard gate on first-time contributors, not a problem with your PR β€” so if the checks look like they are doing nothing, that is why. Once a maintainer approves, CI and the compatibility suite start automatically. Nothing is needed from you in the meantime.
+
+ While you wait, a couple of things that make review faster:
+
+ - Link the issue this fixes with `Closes #N` in the description
+ - Commits follow [Conventional Commits](https://www.conventionalcommits.org/) (`feat(s3): ...`, `fix(dynamodb): ...`)
+ - Behaviour changes come with a test β€” see [CONTRIBUTING.md](https://github.com/floci-io/floci/blob/main/CONTRIBUTING.md)
+
+ Come join us in [Slack](https://join.slack.com/t/floci/shared_invite/zt-3tjn02s3q-A00kEjJ1cZxsg_imTfy6Cw) β€” it is the fastest way to reach maintainers if you get stuck, or want feedback on an approach before investing more time in it.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 02f7a3bcee..ad2696be29 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,6 +2,8 @@
Thank you for your interest in contributing! Floci is a community-driven project and all contributions are welcome.
+**Join us on [Slack](https://join.slack.com/t/floci/shared_invite/zt-3tjn02s3q-A00kEjJ1cZxsg_imTfy6Cw)** β€” it is the fastest way to reach maintainers. Ask about AWS behaviour, sanity-check an approach before you build it, or get unstuck on a PR.
+
## Ways to Contribute
- **Bug reports** β€” open an issue with a minimal reproduction
diff --git a/docs/contributing.md b/docs/contributing.md
index 79752daed4..b855820b5a 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -2,6 +2,8 @@
Floci is MIT licensed and welcomes contributions of all kinds.
+**Join us on [Slack](https://join.slack.com/t/floci/shared_invite/zt-3tjn02s3q-A00kEjJ1cZxsg_imTfy6Cw)** β€” the fastest way to reach maintainers for questions, design tradeoffs, or feedback on an approach before you build it.
+
## Ways to Help
- **Bug reports** β€” open a [GitHub issue](https://github.com/floci-io/floci/issues/new?template=bug_report.md) with a minimal reproduction