@vfarcic/dot-ai 0.119.0 → 0.124.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/images/logo.png +0 -0
- package/assets/project-setup/discovery-config.json +671 -0
- package/assets/project-setup/templates/ADOPTERS.md.hbs +119 -0
- package/assets/project-setup/templates/CODE_OF_CONDUCT.md.hbs +132 -0
- package/assets/project-setup/templates/CONTRIBUTING.md.hbs +159 -0
- package/assets/project-setup/templates/LICENSE.hbs +933 -0
- package/assets/project-setup/templates/NOTICE.hbs +5 -0
- package/assets/project-setup/templates/README.md.hbs +11 -0
- package/assets/project-setup/templates/SECURITY.md.hbs +44 -0
- package/assets/project-setup/templates/SUPPORT.md.hbs +146 -0
- package/assets/project-setup/templates/docs/GOVERNANCE.md.hbs +127 -0
- package/assets/project-setup/templates/docs/MAINTAINERS.md.hbs +49 -0
- package/assets/project-setup/templates/docs/ROADMAP.md.hbs +63 -0
- package/assets/project-setup/templates/renovate.json.hbs +38 -0
- package/dist/tools/project-setup/discovery.js +3 -3
- package/dist/tools/project-setup/generate-scope.js +2 -2
- package/package.json +2 -1
- package/shared-prompts/prd-done.md +45 -4
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Adopters
|
|
2
|
+
|
|
3
|
+
This page lists organizations and users who are officially using {{projectName}} in production or development environments.
|
|
4
|
+
|
|
5
|
+
{{#if projectDescription}}
|
|
6
|
+
{{projectDescription}} is being used by organizations worldwide for various use cases, from development workflows to production deployments.
|
|
7
|
+
{{/if}}
|
|
8
|
+
|
|
9
|
+
## Organizations Using {{projectName}}
|
|
10
|
+
|
|
11
|
+
{{#if includeUseCase}}
|
|
12
|
+
| Organization | Use Case | Website |
|
|
13
|
+
|--------------|----------|---------|
|
|
14
|
+
{{#if maintainerOrganization}}
|
|
15
|
+
| {{maintainerOrganization}} | {{maintainerUseCase}} | [{{maintainerWebsite}}]({{maintainerWebsite}}) |
|
|
16
|
+
{{else}}
|
|
17
|
+
| *Add your organization here* | *Describe your use case* | *Your website* |
|
|
18
|
+
{{/if}}
|
|
19
|
+
|
|
20
|
+
{{else}}
|
|
21
|
+
{{#if maintainerOrganization}}
|
|
22
|
+
1. [{{maintainerOrganization}}]({{maintainerWebsite}})
|
|
23
|
+
{{else}}
|
|
24
|
+
1. *Add your organization here*
|
|
25
|
+
{{/if}}
|
|
26
|
+
|
|
27
|
+
{{/if}}
|
|
28
|
+
## Adding Your Organization
|
|
29
|
+
|
|
30
|
+
We'd love to hear from organizations using {{projectName}}! Adding your organization helps:
|
|
31
|
+
|
|
32
|
+
- Build confidence for other organizations evaluating {{projectName}}
|
|
33
|
+
- Show the diversity of use cases and industries
|
|
34
|
+
- Recognize your support for the project
|
|
35
|
+
- Connect with other users in your industry
|
|
36
|
+
|
|
37
|
+
### How to Add Yourself
|
|
38
|
+
|
|
39
|
+
1. **Fork this repository**
|
|
40
|
+
2. **Edit this file** (`ADOPTERS.md`)
|
|
41
|
+
3. **Add your organization** {{#if includeUseCase}}to the table above{{else}}to the list above{{/if}} in **alphabetical order**
|
|
42
|
+
4. **Submit a Pull Request**
|
|
43
|
+
|
|
44
|
+
{{#if includeUseCase}}
|
|
45
|
+
#### Information to Include
|
|
46
|
+
|
|
47
|
+
- **Organization**: Your company or organization name
|
|
48
|
+
- **Use Case**: Brief description of how you use {{projectName}} (1-2 sentences)
|
|
49
|
+
- **Website**: Link to your organization's website or public project
|
|
50
|
+
|
|
51
|
+
#### Example Entry
|
|
52
|
+
|
|
53
|
+
```markdown
|
|
54
|
+
| Acme Corporation | Using {{projectName}} to automate infrastructure deployment across 50+ Kubernetes clusters | [acme.com](https://acme.com) |
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
{{else}}
|
|
58
|
+
#### Information to Include
|
|
59
|
+
|
|
60
|
+
- **Organization name**
|
|
61
|
+
- **Website URL** (optional but recommended)
|
|
62
|
+
|
|
63
|
+
#### Example Entry
|
|
64
|
+
|
|
65
|
+
```markdown
|
|
66
|
+
2. [Acme Corporation](https://acme.com)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Please maintain **alphabetical ordering** when adding your organization.
|
|
70
|
+
|
|
71
|
+
{{/if}}
|
|
72
|
+
{{#if requiresDco}}
|
|
73
|
+
### DCO Sign-off Required
|
|
74
|
+
|
|
75
|
+
All commits must be signed off (`git commit --signoff`) to comply with the [Developer Certificate of Origin](https://developercertificate.org/).
|
|
76
|
+
|
|
77
|
+
{{/if}}
|
|
78
|
+
## Verification
|
|
79
|
+
|
|
80
|
+
{{#if requiresVerification}}
|
|
81
|
+
Organizations listed here have been verified by maintainers. When submitting your PR:
|
|
82
|
+
- Include a link to your deployment or public usage
|
|
83
|
+
- Or request verification from a maintainer via email
|
|
84
|
+
|
|
85
|
+
{{else}}
|
|
86
|
+
Organizations self-report their usage through pull requests. While we don't formally verify each entry, we may reach out for clarification or examples.
|
|
87
|
+
|
|
88
|
+
{{/if}}
|
|
89
|
+
## Support and Recognition
|
|
90
|
+
|
|
91
|
+
{{#if recognitionProgram}}
|
|
92
|
+
Organizations listed here are eligible for:
|
|
93
|
+
- Recognition on our website and documentation
|
|
94
|
+
- Early access to new features (optional program)
|
|
95
|
+
- Direct communication channel with maintainers
|
|
96
|
+
- Featured case studies (upon request)
|
|
97
|
+
|
|
98
|
+
Contact {{maintainerEmail}} to learn more about our adopter recognition program.
|
|
99
|
+
|
|
100
|
+
{{else}}
|
|
101
|
+
Thank you to all organizations using {{projectName}}! Your adoption and feedback help drive the project forward.
|
|
102
|
+
|
|
103
|
+
If you'd like to be featured in a case study or share your story, contact {{maintainerEmail}}.
|
|
104
|
+
|
|
105
|
+
{{/if}}
|
|
106
|
+
## Why Share Your Adoption?
|
|
107
|
+
|
|
108
|
+
Publicly sharing your usage:
|
|
109
|
+
- **Helps the project**: Demonstrates real-world validation and builds community trust
|
|
110
|
+
- **Helps others**: Provides proof points for organizations evaluating {{projectName}}
|
|
111
|
+
- **Helps you**: Connects you with other users and increases visibility for your organization
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
**Thank you for using {{projectName}}!** We appreciate your support and willingness to share your experience with the community.
|
|
116
|
+
|
|
117
|
+
{{#if questionsContact}}
|
|
118
|
+
Questions about the adopters list? Contact {{questionsContact}}
|
|
119
|
+
{{/if}}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances
|
|
31
|
+
of any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for
|
|
49
|
+
moderation decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail
|
|
56
|
+
address, posting via an official social media account, or acting as an
|
|
57
|
+
appointed representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
{{enforcementEmail}}. All complaints will be reviewed and investigated
|
|
64
|
+
promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by
|
|
122
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
123
|
+
|
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
127
|
+
|
|
128
|
+
[homepage]: https://www.contributor-covenant.org
|
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
130
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
131
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
132
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# Contributing to {{projectName}}
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing to {{projectName}}! We welcome contributions from the community.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
- [Code of Conduct](#code-of-conduct)
|
|
8
|
+
- [Ways to Contribute](#ways-to-contribute)
|
|
9
|
+
- [Getting Started](#getting-started)
|
|
10
|
+
- [Development Workflow](#development-workflow)
|
|
11
|
+
- [Pull Request Process](#pull-request-process)
|
|
12
|
+
- [Coding Standards](#coding-standards)
|
|
13
|
+
{{#if requiresDco}}
|
|
14
|
+
- [Commit Sign-off](#commit-sign-off)
|
|
15
|
+
{{/if}}
|
|
16
|
+
- [Communication](#communication)
|
|
17
|
+
|
|
18
|
+
## Code of Conduct
|
|
19
|
+
|
|
20
|
+
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
21
|
+
|
|
22
|
+
## Ways to Contribute
|
|
23
|
+
|
|
24
|
+
There are many ways to contribute:
|
|
25
|
+
|
|
26
|
+
- **Report bugs** - File detailed bug reports with reproduction steps
|
|
27
|
+
- **Suggest features** - Propose new features or improvements
|
|
28
|
+
- **Write code** - Submit bug fixes or new features
|
|
29
|
+
- **Improve documentation** - Fix typos, clarify content, add examples
|
|
30
|
+
- **Review pull requests** - Provide feedback on proposed changes
|
|
31
|
+
- **Answer questions** - Help other users in issues or discussions
|
|
32
|
+
- **Write tests** - Improve test coverage
|
|
33
|
+
|
|
34
|
+
## Getting Started
|
|
35
|
+
|
|
36
|
+
1. **Fork the repository** on GitHub
|
|
37
|
+
2. **Clone your fork** locally:
|
|
38
|
+
```bash
|
|
39
|
+
git clone https://github.com/YOUR_USERNAME/{{repoName}}.git
|
|
40
|
+
cd {{repoName}}
|
|
41
|
+
```
|
|
42
|
+
3. **Add upstream remote**:
|
|
43
|
+
```bash
|
|
44
|
+
git remote add upstream {{repositoryUrl}}
|
|
45
|
+
```
|
|
46
|
+
{{#if setupCommand}}
|
|
47
|
+
4. **Install dependencies**:
|
|
48
|
+
```bash
|
|
49
|
+
{{setupCommand}}
|
|
50
|
+
```
|
|
51
|
+
{{else}}
|
|
52
|
+
4. **Install dependencies** - See [README.md](README.md) for setup instructions
|
|
53
|
+
{{/if}}
|
|
54
|
+
|
|
55
|
+
## Development Workflow
|
|
56
|
+
|
|
57
|
+
1. **Create a branch** for your changes:
|
|
58
|
+
```bash
|
|
59
|
+
git checkout -b feature/your-feature-name
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
2. **Make your changes** - Write code, add tests, update docs
|
|
63
|
+
|
|
64
|
+
3. **Test your changes**{{#if testCommand}} - Run `{{testCommand}}`{{/if}}
|
|
65
|
+
|
|
66
|
+
4. **Commit your changes**:
|
|
67
|
+
```bash
|
|
68
|
+
git commit -m "Description of your changes"
|
|
69
|
+
```
|
|
70
|
+
{{#if requiresDco}}
|
|
71
|
+
Use `git commit -s` to sign off your commits (required)
|
|
72
|
+
{{/if}}
|
|
73
|
+
|
|
74
|
+
5. **Push to your fork**:
|
|
75
|
+
```bash
|
|
76
|
+
git push origin feature/your-feature-name
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
6. **Open a Pull Request** on GitHub
|
|
80
|
+
|
|
81
|
+
## Pull Request Process
|
|
82
|
+
|
|
83
|
+
### Before Submitting
|
|
84
|
+
|
|
85
|
+
- Ensure your code follows the project's coding standards
|
|
86
|
+
{{#if testCommand}}
|
|
87
|
+
- Add or update tests for your changes
|
|
88
|
+
- Verify all tests pass: `{{testCommand}}`
|
|
89
|
+
{{/if}}
|
|
90
|
+
{{#if lintCommand}}
|
|
91
|
+
- Run linters: `{{lintCommand}}`
|
|
92
|
+
{{/if}}
|
|
93
|
+
- Update documentation as needed
|
|
94
|
+
- Keep pull requests focused on a single concern
|
|
95
|
+
|
|
96
|
+
### PR Description
|
|
97
|
+
|
|
98
|
+
Include in your pull request description:
|
|
99
|
+
|
|
100
|
+
- **What** - Summary of changes
|
|
101
|
+
- **Why** - Motivation and context
|
|
102
|
+
- **How** - Implementation approach
|
|
103
|
+
- **Testing** - How you tested the changes
|
|
104
|
+
- **Related Issues** - Link any related issues (e.g., "Fixes #123")
|
|
105
|
+
|
|
106
|
+
### Review Process
|
|
107
|
+
|
|
108
|
+
1. Automated checks will run on your PR
|
|
109
|
+
2. Maintainers will review your changes
|
|
110
|
+
3. Address any feedback or requested changes
|
|
111
|
+
4. Once approved, a maintainer will merge your PR
|
|
112
|
+
|
|
113
|
+
## Coding Standards
|
|
114
|
+
|
|
115
|
+
{{#if lintCommand}}
|
|
116
|
+
Follow the project's coding style enforced by `{{lintCommand}}`.
|
|
117
|
+
{{else}}
|
|
118
|
+
- Write clear, readable code
|
|
119
|
+
- Use meaningful names for variables and functions
|
|
120
|
+
- Add comments for complex logic
|
|
121
|
+
- Follow language-specific best practices
|
|
122
|
+
{{/if}}
|
|
123
|
+
|
|
124
|
+
{{#if requiresDco}}
|
|
125
|
+
## Commit Sign-off
|
|
126
|
+
|
|
127
|
+
All commits must be signed off to certify that you have the right to submit the code under the project's license.
|
|
128
|
+
|
|
129
|
+
Add the `-s` flag when committing:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
git commit -s -m "Your commit message"
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
This adds a "Signed-off-by" line:
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
Signed-off-by: Your Name <your.email@example.com>
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Learn more at [https://developercertificate.org/](https://developercertificate.org/)
|
|
142
|
+
{{/if}}
|
|
143
|
+
|
|
144
|
+
## Communication
|
|
145
|
+
|
|
146
|
+
- **Issues** - Report bugs and request features via [GitHub Issues]({{repositoryUrl}}/issues)
|
|
147
|
+
{{#if discussionsUrl}}
|
|
148
|
+
- **Discussions** - Ask questions in [GitHub Discussions]({{discussionsUrl}})
|
|
149
|
+
{{/if}}
|
|
150
|
+
{{#if slackChannel}}
|
|
151
|
+
- **Slack** - Join our community: {{slackChannel}}
|
|
152
|
+
{{/if}}
|
|
153
|
+
{{#if discordUrl}}
|
|
154
|
+
- **Discord** - Chat with the community: {{discordUrl}}
|
|
155
|
+
{{/if}}
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
Thank you for contributing to {{projectName}}!
|