Skip to content

Commit 4d3538a

Browse files
committed
Add issue and PR templates, code of conduct, and security policy
Introduced GitHub issue templates for bug reports, documentation issues, and feature requests to standardize contributions. Added a pull request template to guide contributors. Included a Contributor Covenant Code of Conduct and a SECURITY.md file to outline community standards and security reporting procedures.
1 parent e1a53f5 commit 4d3538a

File tree

6 files changed

+455
-0
lines changed

6 files changed

+455
-0
lines changed
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
name: Bug Report
3+
description: Report a bug or unexpected behavior
4+
title: "[BUG] "
5+
labels: ["bug", "triage"]
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report! Please provide as much detail as possible.
12+
13+
- type: input
14+
id: version
15+
attributes:
16+
label: RustAPI Version
17+
description: What version of RustAPI are you using?
18+
placeholder: e.g., 0.1.0
19+
validations:
20+
required: true
21+
22+
- type: input
23+
id: rust-version
24+
attributes:
25+
label: Rust Version
26+
description: What version of Rust are you using?
27+
placeholder: e.g., 1.75.0
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: os
33+
attributes:
34+
label: Operating System
35+
description: What operating system are you using?
36+
options:
37+
- Windows
38+
- macOS
39+
- Linux
40+
- Other (please specify)
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: description
46+
attributes:
47+
label: Description
48+
description: A clear and concise description of the bug.
49+
placeholder: What happened?
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: reproduction
55+
attributes:
56+
label: Steps to Reproduce
57+
description: Steps to reproduce the behavior.
58+
placeholder: |
59+
1. Go to '...'
60+
2. Click on '....'
61+
3. Scroll down to '....'
62+
4. See error
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: expected-behavior
68+
attributes:
69+
label: Expected Behavior
70+
description: What did you expect to happen?
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: actual-behavior
76+
attributes:
77+
label: Actual Behavior
78+
description: What actually happened?
79+
validations:
80+
required: true
81+
82+
- type: textarea
83+
id: additional-context
84+
attributes:
85+
label: Additional Context
86+
description: Add any other context about the problem here (e.g., screenshots, stack traces, related issues, etc.).
87+
placeholder: |
88+
- Error messages
89+
- Screenshots
90+
- Stack traces
91+
- Related issues
92+
93+
- type: checkboxes
94+
id: checklist
95+
attributes:
96+
label: Checklist
97+
description: Please check the following before submitting your issue.
98+
options:
99+
- label: I have searched for similar issues and couldn't find any.
100+
required: true
101+
- label: I have tried the latest version of RustAPI.
102+
required: true
103+
- label: I have provided all the required information above.
104+
required: true
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
name: Documentation Issue
3+
description: Report issues with documentation
4+
title: "[DOCS] "
5+
labels: ["documentation", "triage"]
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Help us improve our documentation! Please report any issues you've found.
12+
13+
- type: dropdown
14+
id: doc-type
15+
attributes:
16+
label: Documentation Type
17+
description: What type of documentation has the issue?
18+
options:
19+
- README.md
20+
- API Documentation
21+
- Code Comments
22+
- Examples
23+
- Contributing Guide
24+
- Other (please specify)
25+
validations:
26+
required: true
27+
28+
- type: input
29+
id: doc-location
30+
attributes:
31+
label: Location
32+
description: Where is the documentation located?
33+
placeholder: e.g., README.md line 42, or URL to docs.rs
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: description
39+
attributes:
40+
label: Description
41+
description: Describe the documentation issue.
42+
placeholder: |
43+
What's wrong with the documentation?
44+
- Is it unclear?
45+
- Is it incorrect?
46+
- Is it missing?
47+
- Is it outdated?
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: suggested-fix
53+
attributes:
54+
label: Suggested Fix
55+
description: How should the documentation be improved?
56+
placeholder: |
57+
Provide your suggested fix or improvement.
58+
If possible, include the corrected text.
59+
60+
- type: textarea
61+
id: additional-context
62+
attributes:
63+
label: Additional Context
64+
description: Add any other context about the documentation issue here.
65+
placeholder: |
66+
- Screenshots
67+
- Links
68+
- Related issues
69+
70+
- type: checkboxes
71+
id: checklist
72+
attributes:
73+
label: Checklist
74+
description: Please check the following before submitting your documentation issue.
75+
options:
76+
- label: I have searched for similar documentation issues and couldn't find any.
77+
required: true
78+
- label: I have provided all the required information above.
79+
required: true
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: Feature Request
3+
description: Suggest a new feature or enhancement
4+
title: "[FEATURE] "
5+
labels: ["enhancement", "triage"]
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for suggesting a new feature! Your input helps make RustAPI better for everyone.
12+
13+
- type: textarea
14+
id: summary
15+
attributes:
16+
label: Summary
17+
description: A brief description of the feature you'd like to see.
18+
placeholder: What feature would you like to see added?
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: problem
24+
attributes:
25+
label: Problem
26+
description: What problem would this feature solve?
27+
placeholder: |
28+
Is there a problem this feature would solve? If so, describe it.
29+
For example: "I'm always frustrated when..."
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: solution
35+
attributes:
36+
label: Proposed Solution
37+
description: Describe the solution you'd like to see.
38+
placeholder: |
39+
Describe how you think this feature should work. Include:
40+
- API design
41+
- Usage examples
42+
- Implementation details
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: alternatives
48+
attributes:
49+
label: Alternative Solutions
50+
description: Have you considered any alternative solutions?
51+
placeholder: |
52+
Describe any alternative solutions or features you've considered.
53+
Why would this be better than the alternatives?
54+
55+
- type: textarea
56+
id: additional-context
57+
attributes:
58+
label: Additional Context
59+
description: Add any other context or screenshots about the feature request here.
60+
placeholder: |
61+
- Screenshots
62+
- Mockups
63+
- Related issues
64+
- Links to similar features in other projects
65+
66+
- type: checkboxes
67+
id: checklist
68+
attributes:
69+
label: Checklist
70+
description: Please check the following before submitting your feature request.
71+
options:
72+
- label: I have searched for similar feature requests and couldn't find any.
73+
required: true
74+
- label: This feature would benefit other users, not just me.
75+
required: true
76+
- label: I have provided all the required information above.
77+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Description
2+
3+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix (non-breaking change which fixes an issue)
8+
- [ ] New feature (non-breaking change which adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
10+
- [ ] Documentation update
11+
- [ ] Refactoring (no functional changes)
12+
- [ ] Performance improvement
13+
- [ ] Test addition or update
14+
- [ ] CI/CD changes
15+
- [ ] Other (please describe):
16+
17+
## Checklist
18+
19+
- [ ] My code follows the project's style guidelines
20+
- [ ] I have performed a self-review of my own code
21+
- [ ] I have commented my code, particularly in hard-to-understand areas
22+
- [ ] I have made corresponding changes to the documentation
23+
- [ ] My changes generate no new warnings
24+
- [ ] I have added tests that prove my fix is effective or that my feature works
25+
- [ ] New and existing unit tests pass locally with my changes
26+
- [ ] Any dependent changes have been merged and published in downstream modules
27+
28+
## Related Issues
29+
30+
Fixes # (issue number)
31+
32+
## Testing
33+
34+
Please describe the tests that you ran to verify your changes:
35+
36+
- [ ] Unit tests
37+
- [ ] Integration tests
38+
- [ ] Manual testing
39+
- [ ] Other (please describe):
40+
41+
## Screenshots (if applicable)
42+
43+
Add screenshots to help explain your changes.
44+
45+
## Additional Notes
46+
47+
Add any other context about the pull request here.

CODE_OF_CONDUCT.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
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.
30+
31+
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.
32+
33+
## Scope
34+
35+
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 email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tunayengin21@hotmail.com. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**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.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**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.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**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.
64+
65+
### 4. Permanent Ban
66+
67+
**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.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
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].
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76+
77+
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].
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)