Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

62 lines (38 loc) · 3.48 KB

Contributing to SnapWP

Thank you for considering contributing to SnapWP! We appreciate your help in improving this open-source project. By participating in this project, you agree to abide by our Code of Conduct and adhere to the guidelines outlined below.

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming environment for all contributors. If you encounter any issues or wish to report a concern, please email us at [email protected].

How to Contribute

Reporting Issues

Important

Do not report potential security vulnerabilities in the public GitHub repository. Instead, please email us at [email protected].

For more information, refer to our Security Policy.

If you find a bug or have a feature request, please open an issue in the GitHub Issues section. Provide as much detail as possible, including:

  1. A clear description of the issue.
  2. Steps to reproduce the issue.
  3. Any relevant screenshots or logs.

In general, we recommend you adhere to the GitHub issue templates included in this repository whenever possible.

Tip

Note: Before opening a new issue, please search the GitHub Issues to see if a similar issue has already been reported.

If you find an existing issue that matches your concern, you can upvote the issue or add a comment to provide additional context, reproduction steps, or any other relevant information to help the ticket advance.

Submitting Code

  1. Fork the repository: Click the "Fork" button in the top right corner of the repository page to create your own copy of the project.

  2. Make your changes: Implement the changes you'd like to contribute. Ensure that your code adheres to the project's coding standards and guidelines.

Tip

For detailed information on the project's directory structure, local development setup, and testing processes, refer to the DEVELOPMENT.md document.

  1. Write tests: If possible, add/update the necessary Integration/Functional/etc. tests for your changes to ensure that everything works correctly.

  2. Commit and push your changes: Once you're satisfied with your changes, commit them to your forked repository and push them to your branch.

  3. Create a pull request: Submit a Pull Request to the develop branch of this repository. Select your branch and provide a detailed description of your changes. Pull Request titles should be concise, descriptive, and follow the Conventional Commits format. E.g., feat: Add new feature.

Review Process

  1. Your pull request will be reviewed by a maintainer. We'll review all PRs, and make suggestions or changes as needed.
  2. Once approved, your PR will be squashed and merged into the develop branch.

Contributing Documentation

We aim to maintain thorough documentation for all aspects of the project. Please contribute by documenting any new features, endpoints, or functionalities you implement.

You can refer to existing documentation in the docs directory for examples of how to structure and format your documentation.

Thank You!

We appreciate your time and contributions to the SnapWP project. Your efforts help make this project better for everyone!