Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Hasan ÇALIŞIR <[email protected]>
  • Loading branch information
hsntgm authored Jan 9, 2025
1 parent a9d407e commit 767cb4e
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Contributing to Nginx Cache Purge & Preload for Wordpress

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.

## How to Contribute

### Reporting Issues

If you encounter any issues or bugs with the project, please:

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).
2. If the issue is not listed, create a new issue with the following details:
- A clear description of the problem.
- Steps to reproduce the issue.
- Any error messages or logs that could help with debugging.
- Information about your environment (e.g., NGINX version, operating system).

### Creating Pull Requests (PRs)

If you would like to contribute code to this project, please follow these steps:

1. **Fork** the repository to your GitHub account.
2. **Clone** your forked repository to your local machine.
3. Create a **new branch** for your changes. Use this format for naming the branch:
- `feature/<feature-name>`
- `bugfix/<issue-number>`
4. Make your changes locally and **test** them thoroughly.
5. **Commit** your changes. Write clear, concise commit messages such as:
- `Fix issue with fastcgi_cache purge`
- `Add new preload feature for cache`
6. **Push** your changes to your fork on GitHub.
7. Open a **Pull Request** (PR) to merge your changes into the main repository.
- Provide a clear description of your changes.
- Link to any relevant issues using `#issue-number`.

### Code Style

- Follow the existing code formatting and naming conventions.
- Ensure your code is well-commented and includes relevant explanations where necessary.
- Add tests for new features or bug fixes when applicable.
- Avoid adding unnecessary changes or large refactorings in a single PR.

### PR Review Process

- Once you open a PR, the maintainers will review it as soon as possible.
- You may be asked to make changes or clarifications. Please respond to feedback in a timely manner.
- Once the PR is approved, it will be merged into the main branch.

### Community and Behavioral Expectations

By contributing to this project, you agree to follow our community guidelines:

- Be respectful and considerate to other contributors.
- Communicate in a professional and constructive manner.
- Be patient, and provide clear explanations when reporting issues or suggesting changes.

## Additional Resources

- [GitHub Docs - Contributing to a Project](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests)
- [Open Source Guides](https://opensource.guide)

We appreciate your contributions! Thanks for helping improve **Nginx Cache Purge & Preload for Wordpress**!

0 comments on commit 767cb4e

Please sign in to comment.