Skip to content

Commit 7178d03

Browse files
committed
docs: add contributing guidelines and project philosophy
This adds a CONTRIBUTING.md file to provide guidance for potential contributors while acknowledging the project's personal origins. The document establishes expectations about response times, explains how to contribute effectively, and sets standards for community interaction. It emphasizes that while the project began as a personal tool, community contributions are welcome and appreciated.
1 parent bf33da3 commit 7178d03

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

.github/CONTRIBUTING.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Contributing to Docker Nginx PHP MySQL
2+
3+
First of all, thank you for considering contributing to this project! It started as a personal tool, and I've been pleasantly surprised by its popularity and adoption in the community. This makes your interest in contributing all the more appreciated.
4+
5+
## Important Note
6+
7+
This project was initially created for personal use, and while I'm delighted that many developers find it useful, I may not always be able to respond quickly to issues or pull requests due to other commitments. I apologize in advance for any delays in my responses.
8+
9+
## How to Contribute
10+
11+
Despite the above caveat, contributions are very welcome! Here are some ways you can help improve this project:
12+
13+
### Reporting Bugs
14+
15+
If you find a bug, please create an issue on GitHub with:
16+
17+
- A clear, descriptive title
18+
- A detailed description of the problem
19+
- Steps to reproduce the issue
20+
- Expected and actual behavior
21+
- Screenshots if applicable
22+
- Your environment details (OS, Docker version, etc.)
23+
24+
### Suggesting Enhancements
25+
26+
Ideas to improve the project are always welcome. When suggesting an enhancement:
27+
28+
- Provide a clear description of what you're suggesting
29+
- Explain why this would be valuable to users
30+
- If possible, outline how it could be implemented
31+
32+
### Pull Requests
33+
34+
Pull requests are the best way to propose changes:
35+
36+
1. Fork the repository
37+
2. Create your feature branch: `git checkout -b feature/amazing-feature`
38+
3. Make your changes
39+
4. Update the documentation to reflect your changes
40+
5. Commit your changes: `git commit -m 'Add some amazing feature'`
41+
6. Push to the branch: `git push origin feature/amazing-feature`
42+
7. Open a pull request
43+
44+
#### Guidelines for Pull Requests
45+
46+
- Keep changes focused on a single issue
47+
- Follow the existing code style
48+
- Include tests if applicable
49+
- Update documentation as needed
50+
- Ensure all tests pass
51+
- Reference any relevant issues
52+
53+
## Development Setup
54+
55+
Please refer to the README.md for instructions on setting up the development environment.
56+
57+
## Code of Conduct
58+
59+
### Our Pledge
60+
61+
In the interest of fostering an open and welcoming environment, we pledge to make participation in our project a harassment-free experience 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.
62+
63+
### Our Standards
64+
65+
Examples of behavior that contributes to creating a positive environment include:
66+
67+
- Using welcoming and inclusive language
68+
- Being respectful of differing viewpoints and experiences
69+
- Gracefully accepting constructive criticism
70+
- Focusing on what is best for the community
71+
- Showing empathy towards other community members
72+
73+
Examples of unacceptable behavior include:
74+
75+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
76+
- Trolling, insulting/derogatory comments, and personal or political attacks
77+
- Public or private harassment
78+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
79+
- Other conduct which could reasonably be considered inappropriate in a professional setting
80+
81+
### Our Responsibilities
82+
83+
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.
84+
85+
## License
86+
87+
By contributing to this project, you agree that your contributions will be licensed under the same license as the original project.
88+
89+
Thank you for contributing!

0 commit comments

Comments
 (0)