Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (56 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

85 lines (56 loc) · 3.44 KB

Contributing

Contributions are welcome and will be fully credited.

Before creating an issue or pull request, please take a moment to read and understand this contribution guide.

Etiquette

This project is open source, and the maintainers volunteer their time to build and maintain it. They provide the source code freely with the hope that it will be useful to others. Please be respectful and considerate when raising issues or submitting pull requests.

  • Be respectful: Avoid abusive, angry, or impatient behavior toward maintainers or contributors.
  • Stay constructive: Provide detailed, actionable feedback and clearly describe issues or suggestions.
  • Understand maintainers' decisions: Contributions are accepted at the discretion of the maintainers. Respect their decision, even if your submission is not used.

Let’s show the world that developers are civilized, collaborative, and selfless!

Viability

Before suggesting new features or changes, consider their viability:

  • Will the feature benefit other users of the project?
  • Is the feature aligned with the project's scope and goals?
  • Could the feature introduce unnecessary complexity or maintenance challenges?

Open source projects serve a diverse group of developers with varied needs, so your contributions should aim to add value to the broader community.

Reporting Issues

Before filing an issue:

  1. Attempt to replicate the problem to rule out one-off incidents.
  2. Search existing issues to ensure your problem or suggestion hasn’t already been raised.
  3. Check pull requests for ongoing work that may address the issue.

Submitting Pull Requests

When submitting a pull request:

  1. Ensure the feature doesn’t already exist in the codebase.
  2. Review existing pull requests to ensure no one else is working on the same feature or fix.
  3. Follow these best practices:
    • One pull request per feature: If you want to contribute multiple changes, submit separate pull requests for each.
    • Provide a coherent commit history: Squash intermediate commits into meaningful ones.
    • Document your changes: Update the README.md or other relevant documentation to reflect your changes.
    • Adhere to coding standards: Use the PSR-12 coding standard.

Requirements

This project follows specific standards and guidelines to ensure consistency and maintainability:

  1. Coding Standard

  2. Semantic Versioning

    • This project adheres to SemVer v2.0.0.
    • Avoid making random or unnecessary breaking changes to public APIs.

  3. Documentation

    • Document any changes in functionality.
    • Update all relevant files, including README.md and other documentation, as needed.

Contribution Workflow

To contribute effectively:

  1. Fork the repository and create a new branch for your work.
  2. Ensure your branch is up-to-date with the main branch.
  3. Implement your feature or fix, ensuring compliance with the guidelines.
  4. Run tests and ensure no existing functionality is broken.
  5. Create a pull request with a clear description of the changes and why they are necessary.

Thank you for contributing! Your effort and time are greatly appreciated. Let’s build something amazing together.

Happy coding!