Skip to content

Commit 7b86c3b

Browse files
authored
Merge pull request #16 from mubbi/feature/standard-guides
docs: added standard docs for project
2 parents 5397d38 + 51c39c2 commit 7b86c3b

File tree

6 files changed

+146
-0
lines changed

6 files changed

+146
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
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:
12+
- Demonstrating empathy and kindness
13+
- Being respectful of differing opinions
14+
- Giving and gracefully accepting feedback
15+
- Accepting responsibility and apologizing for mistakes
16+
- Focusing on what is best for the community
17+
18+
Examples of unacceptable behavior:
19+
- Use of sexualized language or imagery
20+
- Trolling, insulting, or derogatory comments
21+
- Personal or political attacks
22+
- Public or private harassment
23+
- Publishing others’ private information
24+
- Other conduct which could be deemed inappropriate
25+
26+
## Enforcement Responsibilities
27+
28+
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.
29+
30+
## Scope
31+
32+
This Code of Conduct applies within all project spaces and in public spaces when an individual is representing the project or its community.
33+
34+
## Enforcement
35+
36+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at [[email protected]]. All complaints will be reviewed and investigated promptly and fairly.
37+
38+
## Attribution
39+
40+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1.
41+
42+
[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing Guide
2+
3+
Thank you for considering contributing to the Laravel Blog API!
4+
5+
## Development Workflow
6+
- Use Docker and `make` commands for setup and development.
7+
- Run `make lint` and `make analyze` before submitting code.
8+
- Write and run tests with `make test`.
9+
- Use semantic commit messages (see SEMANTIC-COMMITS.md).
10+
11+
## Pull Requests
12+
- Fork the repo and create your branch from `main` or `develop`.
13+
- Ensure your code passes all CI checks.
14+
- Add/Update tests as needed.
15+
- Document new features in the README if necessary.
16+
17+
## Code Style
18+
- Follow PSR-12 and use Laravel Pint for formatting.
19+
- Use PHPStan for static analysis.
20+
21+
## Reporting Issues
22+
- Use the issue templates for bug reports and feature requests.
23+
- Provide as much detail as possible.
24+
25+
## Community
26+
- Be respectful and follow our Code of Conduct.
27+
28+
---
29+
30+
Happy coding!
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: "Bug Report"
3+
about: "Report a reproducible bug in the Laravel Blog API"
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Run '...'
16+
3. See error
17+
18+
**Expected behavior**
19+
A clear and concise description of what you expected to happen.
20+
21+
**Screenshots/Logs**
22+
If applicable, add screenshots or logs to help explain your problem.
23+
24+
**Environment (please complete the following information):**
25+
- OS: [e.g. Windows, Mac, Linux]
26+
- Browser [if relevant]
27+
- API version [e.g. v1]
28+
29+
**Additional context**
30+
Add any other context about the problem here.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "Feature Request"
3+
about: "Suggest a new feature or improvement for the Laravel Blog API"
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is.
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Pull Request
2+
3+
Thank you for your contribution!
4+
5+
## Checklist
6+
- [ ] My code follows the project style and guidelines
7+
- [ ] I have run `make lint` and `make analyze`
8+
- [ ] I have added/updated tests as needed
9+
- [ ] I have updated documentation as needed
10+
- [ ] My commit messages are semantic and descriptive
11+
12+
## Description
13+
Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.
14+
15+
## Related Issue
16+
Fixes # (issue)

.github/SECURITY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
We release security updates for the latest major version. Please ensure you are using the latest release.
5+
6+
## Reporting a Vulnerability
7+
If you discover a security vulnerability, please email [[email protected]] with details. Do **not** create a public issue for security problems.
8+
9+
We will respond as quickly as possible and coordinate a fix.

0 commit comments

Comments
 (0)