Skip to content

Commit 491eb17

Browse files
authored
Feat 018 (#51)
* chore(update): Update template using ```cookiecutter_project_upgrader``` from cookiecutter-cookiecutter.
1 parent dc070fc commit 491eb17

37 files changed

+418
-80
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Community Code of Conduct
2+
3+
## Our Pledge
4+
5+
We pledge to make our community welcoming, safe, and equal for all.
6+
7+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
8+
9+
10+
## Encouraged Behaviors
11+
12+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
13+
14+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
15+
16+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
17+
2. Engaging **kindly and honestly** with others.
18+
3. Respecting **different viewpoints** and experiences.
19+
4. **Taking responsibility** for our actions and contributions.
20+
5. Gracefully giving and accepting **constructive feedback**.
21+
6. Committing to **repairing harm** when it occurs.
22+
7. Behaving in other ways that promote and sustain the **well-being of our community**.
23+
24+
25+
## Restricted Behaviors
26+
27+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
28+
29+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
30+
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
31+
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
32+
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
33+
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
34+
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
35+
7. Behaving in other ways that **threaten the well-being** of our community.
36+
37+
### Other Restrictions
38+
39+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
40+
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
41+
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
42+
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
43+
44+
45+
## Reporting an Issue
46+
47+
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
48+
49+
When an incident does occur, it is important to report it promptly.
50+
51+
To report a possible violation, please email [jcook3701's Email](mailto:jcook3701+github@gmail.com?subject=Report:%20Community%20Code%20of%20Conduct).
52+
53+
All reports will be handled with strict confidentiality. Your email should include:
54+
55+
* **Date and time** of the incident.
56+
* **A description** of what occurred.
57+
* **Links or screenshots** to any relevant public or private messages/logs.
58+
* **Witnesses**, if any were present.
59+
60+
<!-- TODO: Eventually add members to the team to make this possible. Not currently feasible with only one developer.
61+
62+
If the report involves a member of the moderation team, you may instead contact [Alternative Individual’s Email] to ensure an impartial review -->
63+
64+
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
65+
66+
67+
## Addressing and Repairing Harm
68+
69+
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
70+
71+
1) Warning
72+
1) Event: A violation involving a single incident or series of incidents.
73+
2) Consequence: A private, written warning from the Community Moderators.
74+
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
75+
2) Temporarily Limited Activities
76+
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
77+
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
78+
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
79+
3) Temporary Suspension
80+
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
81+
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
82+
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
83+
4) Permanent Ban
84+
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
85+
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
86+
3) Repair: There is no possible repair in cases of this severity.
87+
88+
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
89+
90+
91+
## Scope
92+
93+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
94+
95+
96+
## Attribution
97+
98+
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). This version has been modified to replace "equity" with "equal."
99+
100+
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
101+
102+
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).

.github/CONTRIBUTING.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ An issue that is about a real bug is closed as soon as the fix is committed.
4545
### Reporting Security Issues
4646

4747
If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited.
48-
Please send the related information to <jcook3701+github-docs-cookiecutter@gmail.com>.
48+
Please send the related information to [jcook3701's email](mailto:jcook3701+github-docs-cookiecutter@gmail.com?subject=Report:%20Security%20Vulnerability).
4949

5050
### Usage of Labels
5151

@@ -74,22 +74,17 @@ Bug report analysis support is very welcome! (e.g. pre-analysis or proposing sol
7474

7575
You are welcome to contribute code to github-docs-cookiecutter in order to fix bugs or to implement new features.
7676

77-
<!-- TODO: [Developer Certificate of Origin](https://developercertificate.org/) -->
7877
There are three important things to know:
79-
1. You must be aware that you need to submit [CLA](/docs/jekyll/_manual/developer-resources/cla.md) in order for your contribution to be accepted. This is common practice in all major Open Source projects.
78+
1. You must be aware that you need to submit [CLA](https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/cla) in order for your contribution to be accepted. This is common practice in all major Open Source projects.
8079
2. There are **several requirements regarding code style, quality, and product standards** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines.
8180
3. **Not all proposed contributions can be accepted**. Some features may e.g. just fit a third-party add-on better. The code must fit the overall direction of github-docs-cookiecutter and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the feature you plan to implement (make it clear you intend to contribute).
8281

83-
<!-- TODO: This should be a template option eventually
84-
## Developer Certificate of Origin (DCO)
85-
86-
Due to legal reasons, contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. We use [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
87-
-->
88-
8982
## Contributor License Agreement (CLA)
9083

91-
Due to legal reasons, contributors will be asked to accept a CLA before they submit the first pull request to this project, this happens in an automated fashion during the submission process. We use a derivative of the [ASF Contributor Agreements](https://www.apache.org/licenses/contributor-agreements.html)
92-
[ICLA] and [CCLA].
84+
Due to legal reasons, contributors will be asked to accept a [CLA](https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/cla) before they submit the first pull request to this project, this happens in an automated fashion during the submission process. We use a derivative of the [ASF Contributor Agreements](https://www.apache.org/licenses/contributor-agreements.html) as can be found below.
85+
86+
* [ICLA](https://www.apache.org/licenses/icla.pdf)
87+
* [CCLA](https://www.apache.org/licenses/cla-corporate.pdf).
9388

9489
### Contribution Content Guidelines
9590

.github/FUNDING.yml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
1-
# These are supported funding model platforms
1+
# FUNDING.yml for github-docs-cookiecutter
2+
#
3+
# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook
4+
# SPDX-License-Identifier: AGPL-3.0-or-later
5+
#
6+
# This program is free software: you can redistribute it and/or modify
7+
# it under the terms of the GNU Affero General Public License as
8+
# published by the Free Software Foundation, either version 3 of the
9+
# License, or (at your option) any later version.
10+
#
11+
# This program is distributed in the hope that it will be useful,
12+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
# GNU Affero General Public License for more details.
15+
#
16+
# You should have received a copy of the GNU Affero General Public License
17+
# along with this program. If not, see <https://www.gnu.org/licenses/>.
218
---
319

420
# github: ["jcook3701"]

.github/ISSUE_TEMPLATE/01-bug-report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 01-bug_report.yml for github-docs-cookiecutter
1+
# 01-bug-report.yml for github-docs-cookiecutter
22
#
33
# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook
44
# SPDX-License-Identifier: AGPL-3.0-or-later

.github/SECURITY.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,20 @@ The github-docs-cookiecutter project is built with security and data privacy in
55
## Reporting
66
We are grateful for security researchers and users reporting a vulnerability to us, first. To ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities can be assured, please follow the below guideline.
77

8-
__Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.__
8+
**Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.**
99

10-
For reporting a vulnerability, please send an email directly to <jcook3701+github-docs-cookiecutter-security@gmail.com>. Please address questions about data privacy, security concepts, and other media requests for Security Researchers on our team.
10+
For reporting a vulnerability, please send an email directly to [jcook3701's email](mailto:jcook3701+security-vulnerability@gmail.com?subject=Report:%20Security%20Vulnerability).
11+
12+
To help us verify and resolve issues efficiently, please ensure your security vulnerability report includes the following:
13+
14+
* **Vulnerability Type** and the specific component or URL affected.
15+
* **Detailed Steps** to Reproduce the issue, including any specific configurations needed.
16+
* **Proof of Concept (PoC)** such as HTTP requests, scripts, or screen recordings.
17+
* **Impact Assessment** describing what a successful exploit would allow an attacker to do.
18+
* **Reproduction Environment** details, including the browser, OS, or software version used.
19+
* **Suggested Mitigation** or fix, if you have identified one.
20+
21+
All reports are handled with strict confidentiality. We ask that you follow responsible disclosure by giving us reasonable time to investigate and fix the issue before sharing any details publicly.
1122

1223
## Disclosure Handling
1324
We are committed to timely review and respond to your request. The resolution of code defects will be handled by a dedicated group of security experts and prepared in a private GitHub repository. The project will inform the public about resolved security vulnerabilities via GitHub Security Advisories.

.github/SUPPORT.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Support Guidelines
2+
3+
Thank you for using the github-docs-cookiecutter project! To help us maintain it efficiently, please check these resources before opening an issue.
4+
5+
## 🛠️ Getting Help
6+
* **Documentation:** Start by reading our [Project Wiki](https://jcook3701.github.io/github-docs-cookiecutter).
7+
* **FAQ:** Common questions are answered in our [Frequently Asked Questions](https://jcook3701.github.io/github-docs-cookiecutter/manual/troubleshooting/faq).
8+
* **Community Forums:** For general questions and "how-to" help, please use [GitHub Discussions](https://github.com/jcook3701/github-docs-cookiecutter/discussions) instead of Issues.
9+
10+
## 🐛 Reporting Bugs
11+
If you have found a bug, please:
12+
1. Search existing [Issues](https://github.com/jcook3701/github-docs-cookiecutter/issues?state=open) to see if it has already been reported.
13+
2. Follow the [bug report template](ISSUE_TEMPLATE/01-bug-report.yml) to provide a reproducible example.
14+
15+
## 🔒 Security Vulnerabilities
16+
Please **do not** report security vulnerabilities via public issues. Instead, follow our [Security Policy](https://github.com/jcook3701/github-docs-cookiecutter/blob/master/.github/SECURITY.md) to report them privately.
17+
18+
## ⏳ Response Times
19+
This is an open-source project maintained by volunteers. We try to respond within **48-72 hours**, but please be patient as we balance this with other commitments.
20+
21+
## 🌱 Funding and Sponsorship
22+
23+
github-docs-cookiecutter is an open-source project maintained by volunteers. Your financial support helps sustain the project by covering:
24+
25+
* **Infrastructure costs:** Domain names, hosting, and CI/CD services.
26+
* **Time:** Allowing maintainers to dedicate more time to bug fixes and new features.
27+
28+
If this project has helped you, please consider supporting us through one of the following methods:
29+
<!-- TODO:
30+
Look into GitHub Sponsors:
31+
* **[GitHub Sponsors](URL_HERE):** Ideal for recurring, direct support.
32+
* **[Open Collective](URL_HERE):** Best for corporate sponsorship and transparent expense management.
33+
-->
34+
* **[Buy Me a Coffee](https://buymeacoffee.com/jcook3701):** A simple way to provide a one-time donation.
35+
36+
We greatly appreciate your support!

0 commit comments

Comments
 (0)