Skip to content

Commit e821226

Browse files
Andrew-PaystackAndrew-Paystack
authored
Merge pull request #5 from PaystackOSS/feat/issue-templates
Add contributing guide, C-O-C and issue templates
2 parents 8090fbe + 76a8343 commit e821226

5 files changed

Lines changed: 189 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/1-bug.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
projects: "paystack-mcp-server"
6+
type: bug
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
12+
information as you can to help us resolve the issue.
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: What happened?
17+
description: Also tell us, what did you expect to happen?
18+
placeholder: Tell us what you see
19+
value: "A bug happened!"
20+
validations:
21+
required: true
22+
- type: dropdown
23+
id: version
24+
attributes:
25+
label: Version
26+
description: What version of our software are you running?
27+
options:
28+
- 1.0.2 (Default)
29+
- 1.0.3 (Edge)
30+
default: 0
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: logs
35+
attributes:
36+
label: Relevant log output
37+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
38+
render: shell
39+
- type: checkboxes
40+
id: terms
41+
attributes:
42+
label: Code of Conduct
43+
description: By submitting this bug report, you agree to follow our Code of Conduct
44+
options:
45+
- label: I agree to follow the project's Code of Conduct
46+
required: true

‎.github/ISSUE_TEMPLATE/2-feature-request.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: 💡 Feature Request
2+
description: Suggest a new feature or enhancement for this project
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to suggest a new feature! Please fill out the form below to help us understand your request.
10+
11+
- type: textarea
12+
id: feature-description
13+
attributes:
14+
label: Feature Description
15+
description: A clear and concise description of the feature you'd like to see implemented.
16+
placeholder: Describe the feature you'd like...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Alternatives Considered
24+
description: Have you considered any alternative solutions or features?
25+
placeholder: I've considered...
26+
validations:
27+
required: true
28+
29+
- type: dropdown
30+
id: priority
31+
attributes:
32+
label: Priority
33+
description: How important is this feature to you?
34+
options:
35+
- Low - Nice to have
36+
- Medium - Would improve my workflow
37+
- High - Blocking my work
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: additional-context
43+
attributes:
44+
label: Additional Context
45+
description: Add any other context, screenshots, or examples about the feature request.
46+
placeholder: Any additional information...
47+
validations:
48+
required: false
49+
- type: checkboxes
50+
id: terms
51+
attributes:
52+
label: Code of Conduct
53+
description: By submitting this feature request, you agree to follow our Code of Conduct
54+
options:
55+
- label: I agree to follow the project's Code of Conduct
56+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Paystack Community Support
4+
url: https://https://payslack.slack.com/
5+
about: Please join our Slack workspace for community support and discussions.

‎code-of-conduct.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We are committed to providing a welcoming and inclusive environment for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
## Enforcement
30+
31+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated promptly and fairly.
32+
33+
## Attribution
34+
35+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0.

‎contributing.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing Guide
2+
3+
Thank you for considering contributing to this project! We welcome contributions from everyone.
4+
5+
## Getting Started
6+
7+
1. **Fork the repository** and clone it locally
8+
2. **Install dependencies**: `npm install`
9+
3. **Create a branch** for your changes: `git checkout -b my-feature-branch`
10+
11+
## Making Changes
12+
13+
1. Make your changes in your feature branch
14+
2. Write or update tests as needed
15+
3. Ensure all tests pass: `npm test`
16+
4. Follow the existing code style and conventions
17+
5. Write clear, concise commit messages
18+
19+
## Submitting a Pull Request
20+
21+
1. Push your changes to your fork
22+
2. Open a pull request against the `main` branch
23+
3. Provide a clear description of the changes
24+
4. Link any related issues
25+
5. Wait for review and address any feedback
26+
27+
## Code Style
28+
29+
- Use consistent formatting (we use Prettier/ESLint)
30+
- Write meaningful variable and function names
31+
- Add comments for complex logic
32+
- Keep functions small and focused
33+
34+
## Reporting Issues
35+
36+
- Use the issue templates provided
37+
- Include as much detail as possible
38+
- Provide steps to reproduce bugs
39+
- Include system/environment information
40+
41+
## Questions?
42+
43+
Feel free to open an issue for any questions or concerns.
44+
45+
## Code of Conduct
46+
47+
By participating in this project, you agree to abide by our Code of Conduct.

0 commit comments

Comments
 (0)