diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5be8a90 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,42 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our project and 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, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment: +- Demonstrating empathy and kindness +- Being respectful of differing opinions +- Giving and gracefully accepting feedback +- Accepting responsibility and apologizing for mistakes +- Focusing on what is best for the community + +Examples of unacceptable behavior: +- Use of sexualized language or imagery +- Trolling, insulting, or derogatory comments +- Personal or political attacks +- Public or private harassment +- Publishing others’ private information +- Other conduct which could be deemed inappropriate + +## Enforcement Responsibilities + +Project maintainers are responsible for clarifying and enforcing standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces and in public spaces when an individual is representing the project or its community. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at [hello@mubbi.me]. All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1. + +[homepage]: https://www.contributor-covenant.org diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..f4e9d79 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing Guide + +Thank you for considering contributing to the Laravel Blog API! + +## Development Workflow +- Use Docker and `make` commands for setup and development. +- Run `make lint` and `make analyze` before submitting code. +- Write and run tests with `make test`. +- Use semantic commit messages (see SEMANTIC-COMMITS.md). + +## Pull Requests +- Fork the repo and create your branch from `main` or `develop`. +- Ensure your code passes all CI checks. +- Add/Update tests as needed. +- Document new features in the README if necessary. + +## Code Style +- Follow PSR-12 and use Laravel Pint for formatting. +- Use PHPStan for static analysis. + +## Reporting Issues +- Use the issue templates for bug reports and feature requests. +- Provide as much detail as possible. + +## Community +- Be respectful and follow our Code of Conduct. + +--- + +Happy coding! diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..21ad9d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: "Bug Report" +about: "Report a reproducible bug in the Laravel Blog API" +title: "[Bug] " +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Run '...' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots/Logs** +If applicable, add screenshots or logs to help explain your problem. + +**Environment (please complete the following information):** +- OS: [e.g. Windows, Mac, Linux] +- Browser [if relevant] +- API version [e.g. v1] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..b849435 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: "Feature Request" +about: "Suggest a new feature or improvement for the Laravel Blog API" +title: "[Feature] " +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..2ae24fb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +# Pull Request + +Thank you for your contribution! + +## Checklist +- [ ] My code follows the project style and guidelines +- [ ] I have run `make lint` and `make analyze` +- [ ] I have added/updated tests as needed +- [ ] I have updated documentation as needed +- [ ] My commit messages are semantic and descriptive + +## Description +Please include a summary of the change and which issue is fixed. Also include relevant motivation and context. + +## Related Issue +Fixes # (issue) diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..ace9603 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,9 @@ +# Security Policy + +## Supported Versions +We release security updates for the latest major version. Please ensure you are using the latest release. + +## Reporting a Vulnerability +If you discover a security vulnerability, please email [hello@mubbi.me] with details. Do **not** create a public issue for security problems. + +We will respond as quickly as possible and coordinate a fix.