Skip to content

Commit a40801b

Browse files
authored
Create CONTRIBUTING.md (#19)
Signed-off-by: Hasan ÇALIŞIR <hasan.calisir@psauxit.com>
1 parent a9d407e commit a40801b

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing to Nginx Cache Purge & Preload for Wordpress
2+
3+
Thank you for considering contributing to the **Nginx Cache Purge & Preload for Wordpress** project! We appreciate any contributions, whether they be bug reports, code improvements, or documentation enhancements.
4+
5+
## How to Contribute
6+
7+
### Reporting Issues
8+
9+
If you encounter any issues or bugs with the project, please:
10+
11+
1. **Check** if the issue has already been reported by searching through the existing [Issues](https://github.com/psaux-it/nginx-fastcgi-cache-purge-and-preload/issues).
12+
2. If the issue is not listed, create a new issue with the following details:
13+
- A clear description of the problem.
14+
- Steps to reproduce the issue.
15+
- Any error messages or logs that could help with debugging.
16+
- Information about your environment (e.g., NGINX version, operating system).
17+
18+
### Creating Pull Requests (PRs)
19+
20+
If you would like to contribute code to this project, please follow these steps:
21+
22+
1. **Fork** the repository to your GitHub account.
23+
2. **Clone** your forked repository to your local machine.
24+
3. Create a **new branch** for your changes. Use this format for naming the branch:
25+
- `feature/<feature-name>`
26+
- `bugfix/<issue-number>`
27+
4. Make your changes locally and **test** them thoroughly.
28+
5. **Commit** your changes. Write clear, concise commit messages such as:
29+
- `Fix issue with fastcgi_cache purge`
30+
- `Add new preload feature for cache`
31+
6. **Push** your changes to your fork on GitHub.
32+
7. Open a **Pull Request** (PR) to merge your changes into the main repository.
33+
- Provide a clear description of your changes.
34+
- Link to any relevant issues using `#issue-number`.
35+
36+
### Code Style
37+
38+
- Follow the existing code formatting and naming conventions.
39+
- Ensure your code is well-commented and includes relevant explanations where necessary.
40+
- Add tests for new features or bug fixes when applicable.
41+
- Avoid adding unnecessary changes or large refactorings in a single PR.
42+
43+
### PR Review Process
44+
45+
- Once you open a PR, the maintainers will review it as soon as possible.
46+
- You may be asked to make changes or clarifications. Please respond to feedback in a timely manner.
47+
- Once the PR is approved, it will be merged into the main branch.
48+
49+
### Community and Behavioral Expectations
50+
51+
By contributing to this project, you agree to follow our community guidelines:
52+
53+
- Be respectful and considerate to other contributors.
54+
- Communicate in a professional and constructive manner.
55+
- Be patient, and provide clear explanations when reporting issues or suggesting changes.
56+
57+
## Additional Resources
58+
59+
- [GitHub Docs - Contributing to a Project](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests)
60+
- [Open Source Guides](https://opensource.guide)
61+
62+
We appreciate your contributions! Thanks for helping improve **Nginx Cache Purge & Preload for Wordpress**!

0 commit comments

Comments
 (0)