Skip to content

Commit 2484faa

Browse files
YagoBorbaYagoBorba
authored
Merge pull request #37 from YagoBorba/feature/improve-documentation
docs(docs): 📝 expand and improve project documentation structure
2 parents 28d7afe + 4d92315 commit 2484faa

16 files changed

Lines changed: 495 additions & 22 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug to help us improve StackCode
3+
title: "🐛 [Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report! 🙏
10+
11+
- type: input
12+
id: version
13+
attributes:
14+
label: Version
15+
description: What version of StackCode are you running?
16+
placeholder: "1.0.3"
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
id: environment
22+
attributes:
23+
label: Environment
24+
description: What environment are you using?
25+
options:
26+
- Windows
27+
- macOS
28+
- Linux
29+
- Other
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: description
35+
attributes:
36+
label: Bug Description
37+
description: A clear and concise description of what the bug is.
38+
placeholder: "Describe the bug..."
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: steps
44+
attributes:
45+
label: Steps to Reproduce
46+
description: Steps to reproduce the behavior
47+
placeholder: |
48+
1. Run command '...'
49+
2. See error
50+
value: |
51+
1.
52+
2.
53+
3.
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: expected
59+
attributes:
60+
label: Expected Behavior
61+
description: What you expected to happen
62+
placeholder: "What should have happened?"
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: actual
68+
attributes:
69+
label: Actual Behavior
70+
description: What actually happened
71+
placeholder: "What actually happened?"
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: logs
77+
attributes:
78+
label: Error Logs
79+
description: If applicable, add error messages or logs
80+
render: shell
81+
placeholder: "Paste any error messages or logs here"
82+
83+
- type: checkboxes
84+
id: terms
85+
attributes:
86+
label: Code of Conduct
87+
description: By submitting this issue, you agree to follow our Code of Conduct
88+
options:
89+
- label: I agree to follow this project's Code of Conduct
90+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement for StackCode
3+
title: "✨ [Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! 🚀
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: "I'm always frustrated when..."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like
25+
placeholder: "I would like to see..."
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered
34+
placeholder: "Alternative approaches could be..."
35+
36+
- type: dropdown
37+
id: priority
38+
attributes:
39+
label: Priority
40+
description: How important is this feature to you?
41+
options:
42+
- Low
43+
- Medium
44+
- High
45+
- Critical
46+
validations:
47+
required: true
48+
49+
- type: checkboxes
50+
id: willing-to-implement
51+
attributes:
52+
label: Implementation
53+
description: Are you willing to work on this feature?
54+
options:
55+
- label: I'm willing to submit a PR for this feature
56+
57+
- type: checkboxes
58+
id: terms
59+
attributes:
60+
label: Code of Conduct
61+
description: By submitting this issue, you agree to follow our Code of Conduct
62+
options:
63+
- label: I agree to follow this project's Code of Conduct
64+
required: true

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: ❓ Question or Support
2+
description: Ask a question about using StackCode
3+
title: "❓ [Question]: "
4+
labels: ["question", "support"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for your question! 🤔
10+
Before submitting, please check if your question is already answered in:
11+
- [README.md](https://github.com/YagoBorba/StackCode/blob/develop/README.md)
12+
- [CONTRIBUTING.md](https://github.com/YagoBorba/StackCode/blob/develop/CONTRIBUTING.md)
13+
- [Existing Issues](https://github.com/YagoBorba/StackCode/issues)
14+
15+
- type: textarea
16+
id: question
17+
attributes:
18+
label: Your Question
19+
description: What would you like to know?
20+
placeholder: "How can I...?"
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: context
26+
attributes:
27+
label: Additional Context
28+
description: Add any other context about your question
29+
placeholder: "I'm trying to... but..."
30+
31+
- type: checkboxes
32+
id: terms
33+
attributes:
34+
label: Code of Conduct
35+
description: By submitting this issue, you agree to follow our Code of Conduct
36+
options:
37+
- label: I agree to follow this project's Code of Conduct
38+
required: true

‎.github/pull_request_template.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## 📋 Description
2+
3+
<!-- Describe your changes in detail -->
4+
5+
## 🔗 Related Issue
6+
7+
<!-- Please link to the issue here: -->
8+
Fixes #(issue)
9+
10+
## 🧪 Type of Change
11+
12+
<!-- Mark the relevant option with "x" -->
13+
14+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
15+
- [ ] ✨ New feature (non-breaking change which adds functionality)
16+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
17+
- [ ] 📝 Documentation update
18+
- [ ] 🔧 Configuration change
19+
- [ ] 🧹 Code cleanup
20+
- [ ] ♻️ Refactoring
21+
22+
## 📝 How Has This Been Tested?
23+
24+
<!-- Describe the tests that you ran to verify your changes -->
25+
26+
- [ ] Unit tests pass
27+
- [ ] Manual testing completed
28+
- [ ] CI/CD pipeline passes
29+
30+
## 📷 Screenshots (if applicable)
31+
32+
<!-- Add screenshots to help explain your changes -->
33+
34+
## ✅ Checklist
35+
36+
<!-- Mark completed items with "x" -->
37+
38+
- [ ] My code follows the project's coding standards
39+
- [ ] I have performed a self-review of my own code
40+
- [ ] I have commented my code, particularly in hard-to-understand areas
41+
- [ ] I have made corresponding changes to the documentation
42+
- [ ] My changes generate no new warnings
43+
- [ ] I have added tests that prove my fix is effective or that my feature works
44+
- [ ] New and existing unit tests pass locally with my changes
45+
- [ ] I have checked my code and corrected any misspellings
46+
47+
## 🔄 Dependencies
48+
49+
<!-- List any dependencies that are required for this change -->
50+
51+
## 📚 Additional Notes
52+
53+
<!-- Add any other context about the pull request here -->

‎.stackcoderc.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"features": {
3-
"commitValidation": true
3+
"commitValidation": false
44
}
55
}

‎CODE_OF_CONDUCT.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
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, religion, or sexual identity
10+
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
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances 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
35+
address, 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 moderation
49+
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 address,
56+
posting via an official social media account, or acting as an appointed
57+
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+
[https://github.com/YagoBorba](https://github.com/YagoBorba).
64+
All complaints will be reviewed and investigated 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
86+
of 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 interaction in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent 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
113+
the 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+
[homepage]: https://www.contributor-covenant.org
122+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

0 commit comments

Comments
 (0)