Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (38 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 2.31 KB

Contributing to Sinergi PAS

First off, thank you for considering contributing to Sinergi PAS! It's people like you that make Sinergi PAS such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Sinergi PAS. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Sinergi PAS, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most Sinergi PAS users.

Pull Requests

  • Fill in the pull request template.
  • Follow the project's coding standards.
  • Ensure all tests pass.
  • Document any new functionality.
  • Use clear and concise commit messages.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

PHP Coding Standards

We follow the PSR-12 coding standard. You can use Laravel Pint to automatically fix any style issues:

./vendor/bin/pint

CSS Styling

We use Tailwind CSS 4.0. Please avoid writing custom CSS unless absolutely necessary. Use utility classes wherever possible to maintain consistency.

Thank you for your contributions!