Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (72 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

102 lines (72 loc) · 3.61 KB

Contributing to PickZ

Thank you for considering contributing to PickZ! ❤️

Your contributions help improve and enhance the project, making it more useful for everyone. Please follow these guidelines to get started.

Table of Contents

Code of Conduct

Please read and adhere to our Code of Conduct to ensure a welcoming and inclusive environment for everyone.

I Have a Question

Before asking a question, please check the available Documentation.

If you need further assistance, visit our discussions. This is the best place to ask questions, share ideas, and engage with the community.

How Can I Contribute?

Reporting Bugs

Security-related issues, vulnerabilities, or bugs must never be reported publicly. Instead, please email them to info@pickz.org.

If you discover a bug, please report it by opening an issue. Include as much detail as possible to help us diagnose and fix the problem:

  • A clear and descriptive title.
  • Steps to reproduce the issue:
    1. Navigate to '...'
    2. Click on '...'
    3. Scroll down to '...'
    4. Observe the error.
  • Expected vs. actual behavior.
  • Screenshots or code snippets (if applicable).
  • Any relevant log output.

Suggesting Enhancements

If you have an idea to improve PickZ, please open an issue before starting any work. Provide:

  • A clear and descriptive title.
  • A detailed description of the enhancement.
  • Any examples, use cases, or mockups.

Submitting Pull Requests

Legal Notice: By contributing to this project, you confirm that you are the original author of your contributions, that you have the necessary rights to contribute the content, and that your contributions will be licensed under the project's license.

Before submitting a pull request, ensure you have discussed your changes via an issue. Follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone your fork to your local machine: 
    git clone https://github.com/your-username/PickZ.git
  3. Create a new branch for your changes: 
    git checkout -b my-feature-branch
  4. Make your changes and ensure they work as expected.
  5. Test your changes thoroughly.
  6. Commit your changes with a meaningful message: 
    git commit -m "Description of changes"
  7. Push your changes to your forked repository: 
    git push origin my-feature-branch
  8. Open a pull request against the develop branch of the original repository.

Style Guides

Git Commit Messages

  • Keep the first line within 72 characters.
  • Use clear and descriptive commit messages.
  • Reference issues and pull requests where relevant.

Coding Standards

  • Follow PSR-12 coding standards.
  • Keep your code clean, well-documented, and readable.
  • Ensure your code is properly tested before submission.

License

By contributing, you agree that your contributions will be licensed under the same AGPLv3 license as the project.

Thank you for helping improve PickZ!