diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml new file mode 100644 index 0000000..28bfef6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -0,0 +1,46 @@ +name: Bug Report +description: File a bug report. +title: "[Bug]: " +labels: ["bug", "triage"] +projects: "paystack-mcp-server" +type: bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report. Please provide as much + information as you can to help us resolve the issue. + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - 1.0.2 (Default) + - 1.0.3 (Edge) + default: 0 + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this bug report, you agree to follow our Code of Conduct + options: + - label: I agree to follow the project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml new file mode 100644 index 0000000..86bb028 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml @@ -0,0 +1,56 @@ +name: 💡 Feature Request +description: Suggest a new feature or enhancement for this project +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest a new feature! Please fill out the form below to help us understand your request. + + - type: textarea + id: feature-description + attributes: + label: Feature Description + description: A clear and concise description of the feature you'd like to see implemented. + placeholder: Describe the feature you'd like... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or features? + placeholder: I've considered... + validations: + required: true + + - type: dropdown + id: priority + attributes: + label: Priority + description: How important is this feature to you? + options: + - Low - Nice to have + - Medium - Would improve my workflow + - High - Blocking my work + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context, screenshots, or examples about the feature request. + placeholder: Any additional information... + validations: + required: false + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this feature request, you agree to follow our Code of Conduct + options: + - label: I agree to follow the project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..b12d2d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Paystack Community Support + url: https://https://payslack.slack.com/ + about: Please join our Slack workspace for community support and discussions. \ No newline at end of file diff --git a/code-of-conduct.md b/code-of-conduct.md new file mode 100644 index 0000000..1cf6e45 --- /dev/null +++ b/code-of-conduct.md @@ -0,0 +1,35 @@ +# Code of Conduct + +## Our Pledge + +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. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +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. + +## Enforcement + +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. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0. \ No newline at end of file diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..dcdb31a --- /dev/null +++ b/contributing.md @@ -0,0 +1,47 @@ +# Contributing Guide + +Thank you for considering contributing to this project! We welcome contributions from everyone. + +## Getting Started + +1. **Fork the repository** and clone it locally +2. **Install dependencies**: `npm install` +3. **Create a branch** for your changes: `git checkout -b my-feature-branch` + +## Making Changes + +1. Make your changes in your feature branch +2. Write or update tests as needed +3. Ensure all tests pass: `npm test` +4. Follow the existing code style and conventions +5. Write clear, concise commit messages + +## Submitting a Pull Request + +1. Push your changes to your fork +2. Open a pull request against the `main` branch +3. Provide a clear description of the changes +4. Link any related issues +5. Wait for review and address any feedback + +## Code Style + +- Use consistent formatting (we use Prettier/ESLint) +- Write meaningful variable and function names +- Add comments for complex logic +- Keep functions small and focused + +## Reporting Issues + +- Use the issue templates provided +- Include as much detail as possible +- Provide steps to reproduce bugs +- Include system/environment information + +## Questions? + +Feel free to open an issue for any questions or concerns. + +## Code of Conduct + +By participating in this project, you agree to abide by our Code of Conduct. \ No newline at end of file