Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

60 lines (36 loc) · 2.12 KB

Contribution 🧑‍💻

We appreciate your interest in contributing to this Laravel Roles and Permissions project! Whether you're reporting issues, fixing bugs, or adding new features, your help is greatly appreciated.

Forking and Cloning the Repository

Fork the Repository

  1. Go to the repository page on GitHub.
  2. Click the Fork button at the top-right corner of the repository page.

Clone the Repository

Once you've forked the repository:

  1. Open your terminal or Git Bash.

  2. Clone the repository to your local machine:

    git clone https://github.com/your-username/example-app.git

Reporting Issues

If you encounter any issues or bugs, please check if the issue already exists in the Issues section of the repository. If not, create a new issue and provide as much detail as possible, including:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Laravel version
  • Any relevant logs or screenshots

Submit a Pull Request

When you're ready to submit your changes, go to the repository on GitHub and open a new Pull Request. Describe the changes you've made and how they address the issue or add new functionality.

Submitting Changes

All pull requests will undergo a review process to ensure the changes adhere to the project standards and do not introduce any bugs.

Squashing Commits

We prefer that all commits be squashed into a single commit per pull request. This helps keep the project history clean.

Coding Standards

Please adhere to the following coding standards to ensure consistency across the codebase:

  • PSR-12: Follow the PSR-12 Coding Standard for PHP.
  • Comments: Write clear and concise comments where necessary. Avoid over-commenting but provide clarity for complex logic.

Contributing Guidelines

  • Ensure your pull requests are made from a feature branch (feature/name-of-feature).
  • Document your changes
  • Use a clean and meaningful commit history.

We appreciate your efforts in contributing to this project! For any further questions, feel free to reach out via GitHub.

Happy coding 🧑‍💻!