Skip to content

Commit cfa4a77

Browse files
docs: add Contributor Covenant v2.1 and close out Phase 4 (#115)
* docs: add Contributor Covenant v2.1 and close out Phase 4 CODE_OF_CONDUCT.md is the verbatim Contributor Covenant v2.1 fetched from the canonical source at contributor-covenant.org. The enforcement-contact slot is intentionally left as the standard [INSERT CONTACT METHOD] placeholder — the maintainer plans to swap in a project-specific email separately. CONTRIBUTING.md re-links the CoC under a "Code of conduct" section that was stubbed out in #114 pending this file. Phase 4 is now fully shipped (#107 CI, #113 R8, #114 community docs, this PR CoC); marked Done in docs/IMPROVEMENT_PLAN.md. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * docs: route CoC + CONTRIBUTING to the private Security-tab flow Replace the [INSERT CONTACT METHOD] placeholder in CODE_OF_CONDUCT.md with a pointer at GitHub's "Report a vulnerability" option in the Security tab — the same private channel SECURITY.md documents (added in #116). No email contact is required anywhere in the project. Update CONTRIBUTING.md's "Reporting bugs and security issues" section to drop the prior "email the maintainer" wording in favor of the same flow, and link to SECURITY.md for what reporters should expect. Refresh the IMPROVEMENT_PLAN entry so it no longer claims a maintainer email is planned. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * docs: point issue chooser security link directly at SECURITY.md The "Reporting a security issue" contact link previously routed through CONTRIBUTING.md's anchor — one extra hop for the reporter. Now that #116 has landed SECURITY.md (which describes the same private "Report a vulnerability" flow that this PR's CoC enforcement contact also points at), tighten the chooser to link straight there. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 2dfdaad commit cfa4a77

4 files changed

Lines changed: 103 additions & 11 deletions

File tree

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ contact_links:
44
url: https://github.com/Tarek-Bohdima/ConsultMe/blob/main/docs/IMPROVEMENT_PLAN.md
55
about: Before filing a feature request, check the roadmap — your idea may already be tracked under an upcoming phase or intentionally deferred.
66
- name: Reporting a security issue
7-
url: https://github.com/Tarek-Bohdima/ConsultMe/blob/main/CONTRIBUTING.md#reporting-bugs-and-security-issues
8-
about: Please don't open a public issue for security vulnerabilities — see CONTRIBUTING.md for the disclosure path.
7+
url: https://github.com/Tarek-Bohdima/ConsultMe/blob/main/SECURITY.md
8+
about: Please don't open a public issue for security vulnerabilities — see SECURITY.md for the private "Report a vulnerability" reporting flow.

CODE_OF_CONDUCT.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
7+
8+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
9+
10+
## Our Standards
11+
12+
Examples of behavior that contributes to a positive environment for our community include:
13+
14+
* Demonstrating empathy and kindness toward other people
15+
* Being respectful of differing opinions, viewpoints, and experiences
16+
* Giving and gracefully accepting constructive feedback
17+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
18+
* Focusing on what is best not just for us as individuals, but for the overall community
19+
20+
Examples of unacceptable behavior include:
21+
22+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
23+
* Trolling, insulting or derogatory comments, and personal or political attacks
24+
* Public or private harassment
25+
* Publishing others' private information, such as a physical or email address, without their explicit permission
26+
* Other conduct which could reasonably be considered inappropriate in a professional setting
27+
28+
## Enforcement Responsibilities
29+
30+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
31+
32+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
33+
34+
## Scope
35+
36+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
37+
38+
## Enforcement
39+
40+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. Use the **Report a vulnerability** option in the Security tab. All complaints will be reviewed and investigated promptly and fairly.
41+
42+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
43+
44+
## Enforcement Guidelines
45+
46+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47+
48+
### 1. Correction
49+
50+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51+
52+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
53+
54+
### 2. Warning
55+
56+
**Community Impact**: A violation through a single incident or series of actions.
57+
58+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
59+
60+
### 3. Temporary Ban
61+
62+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
63+
64+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
65+
66+
### 4. Permanent Ban
67+
68+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
69+
70+
**Consequence**: A permanent ban from any sort of public interaction within the community.
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
75+
76+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
77+
78+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
79+
80+
[homepage]: https://www.contributor-covenant.org
81+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
82+
[Mozilla CoC]: https://github.com/mozilla/diversity
83+
[FAQ]: https://www.contributor-covenant.org/faq
84+
[translations]: https://www.contributor-covenant.org/translations
85+

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ that adopters replace). PRs that improve the template's ergonomics, tooling,
77
or documentation are very welcome; PRs that add product features should usually
88
land in a fork instead.
99

10+
## Code of conduct
11+
12+
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
13+
By participating you agree to uphold it.
14+
1015
## Before you start
1116

1217
1. Open an issue for non-trivial changes (anything beyond a doc/typo fix or a
@@ -95,9 +100,10 @@ it when contributing back upstream.
95100
## Reporting bugs and security issues
96101

97102
- **Bugs** — use the [bug report issue template](.github/ISSUE_TEMPLATE/bug_report.md).
98-
- **Security issues** — please don't open a public issue. Email the maintainer
99-
privately (see the GitHub profile linked in `LICENSE.md`) so a fix can ship
100-
before disclosure.
103+
- **Security issues** — please don't open a public issue. Use the **Report a
104+
vulnerability** option in the repository's Security tab; that opens a private
105+
channel visible only to the maintainer. See [`SECURITY.md`](SECURITY.md) for
106+
what to expect after submitting.
101107

102108
Thanks again — every PR that makes the template easier to fork helps the next
103109
adopter.

docs/IMPROVEMENT_PLAN.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ConsultMe is a Jetpack Compose multi-module Android template. This document is t
1010
| 1 | Convention plugins (`build-logic/`) | **Done** (#101) |
1111
| 2 | Template ergonomics (bootstrap script, parameterized header) | **Done** (#104) |
1212
| 3 | Real example tests | **Done** (#105) |
13-
| 4 | Production-readiness (R8, CI artifacts, instrumented tests) | **In progress** — CI sub-piece in this PR; R8 + docs follow-ups still open |
13+
| 4 | Production-readiness (R8, CI artifacts, instrumented tests) | **Done** (#107, #113, #114, #115) |
1414
| 5 | Deferred migrations (AGP 9, Hilt 2.59+, Kotlin 2.3.20) | Blocked by upstream pin in `dependabot.yml` |
1515

1616
Tick the table when phases land. Each phase below lists scope, rationale, and a rough size; sub-bullets are the concrete deltas.
@@ -86,9 +86,9 @@ Goal: replace the empty `ExampleUnitTest` shells with code that doubles as docum
8686
- A Compose UI test asserting the screen renders.
8787
- Each test stays small (≤ 30 lines) — the goal is exemplification, not coverage.
8888

89-
## Phase 4 — Production-readiness (in progress)
89+
## Phase 4 — Production-readiness (done)
9090

91-
Goal: a fork from this template should be one signing config away from a Play release. Splitting this phase across multiple PRs so each piece can be tuned independently.
91+
Goal: a fork from this template should be one signing config away from a Play release. Split across four PRs so each piece could be tuned independently.
9292

9393
**CI sub-piece (#107):**
9494
- `assembleRelease` step in `build_and_test` (catches APK build regressions `test` misses).
@@ -101,13 +101,14 @@ Goal: a fork from this template should be one signing config away from a Play re
101101
- `:app/proguard-rules.pro` rewritten as a slim starter — the only project-specific rule is `-keepattributes SourceFile,LineNumberTable` (with the matching `-renamesourcefileattribute SourceFile`) so production crashes symbolicate via the `mapping.txt` AGP writes under `build/outputs/mapping/release/`. The platform defaults (`proguard-android-optimize.txt`) plus AAR-shipped consumer rules from Hilt, Compose, Room, and kotlinx.coroutines cover the rest. Comments document when adopters need to add their own keeps (reflective serializers, `Class.forName`, etc.) and point at the [`r8-analyzer`](https://github.com/android/skills) Claude Code skill.
102102
- Validated locally: `:app:assembleRelease` ships a 896 KB unsigned release APK; `:app:lintRelease` and `./gradlew test` are clean.
103103

104-
**Community docs sub-piece (this PR):**
104+
**Community docs sub-piece (#114):**
105105
- `CONTRIBUTING.md` at the repo root — scope statement, local setup, the local CI loop, PR conventions (Conventional Commits, branch protection, one-scope-per-PR), license-header note, repo layout, bug/security reporting paths.
106106
- `.github/PULL_REQUEST_TEMPLATE.md` — Summary / Test plan / Reviewer notes / Refs sections, mirroring the format the recent PR queue has been using.
107107
- `.github/ISSUE_TEMPLATE/config.yml` — disables blank issues and surfaces two contact links (the roadmap, and the security-disclosure path documented in `CONTRIBUTING.md`).
108108

109-
**Still open (follow-up PR):**
110-
- Add a polished `CODE_OF_CONDUCT.md` (Contributor Covenant v2.1). Deferred from this PR because the canonical text needs a real enforcement contact filled in, and that's a maintainer decision rather than a template default.
109+
**Code of conduct sub-piece (this PR):**
110+
- `CODE_OF_CONDUCT.md` at the repo root — verbatim Contributor Covenant v2.1, fetched from the canonical source. The enforcement-contact slot routes to GitHub's "Report a vulnerability" private flow (the same channel `SECURITY.md` documents in #116) — no email is required anywhere in the project.
111+
- `CONTRIBUTING.md` re-links the CoC under a "Code of conduct" section, and the "Reporting bugs and security issues" section drops the prior "email the maintainer" wording in favor of the same private Security-tab flow.
111112

112113
## Phase 5 — Deferred migrations
113114

0 commit comments

Comments
 (0)