Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 2.57 KB
Raw

Contributing to our project

We welcome contributions to our project! Whether you're a seasoned developer or new to open source, we appreciate your interest and effort in improving our project. This document will guide you through the process of contributing.

How to contribute

Reporting bugs

If you find a bug, please report it by creating an issue on our GitHub repository. Include as much detail as possible to help us understand and replicate the issue:

  • Title: A concise title summarising the bug.
  • Description: A detailed description of the bug.
  • Steps to Reproduce: A list of steps to reproduce the bug.
  • Expected Behaviour: What you expected to happen.
  • Actual Behaviour: What actually happened.
  • Environment: Information about your environment (e.g., Laravel version, Docker version, browser, etc.).

Suggesting features

We welcome feature suggestions! If you have an idea to improve our project, please create an issue with the following information:

  • Title: A concise title summarising the feature.
  • Description: A detailed description of the feature and its benefits.
  • Use Cases: Examples of how the feature would be used.
  • Alternatives: Any alternative solutions or features you've considered.

Submitting pull requests

If you would like to contribute code, please follow these steps:

  1. Fork the repository: fork our Github repository to your own account.
  2. Up your environment: clone the repository in your local, checkout to a new branch and start to code
  3. Create a pull request: after finish your work, push and start a pull request to main repository.

Code Style

Please adhere to the following coding standards:

  • PHP: always use the Pint to lint your code.
  • JavaScript: not configured yet.

Testing

Ensure that all tests pass before submitting your pull request. We include a validation in repository using GitHub Actions, but you could also use the local Pest installation to validate all tests before submitting.

Any PR you submit must pass in all tests before being merge into the repository.

Community Guidelines

By participating in this project, you agree to abide by our Code Of Conduct. Please treat others with respect and contribute positively to the community.

Getting help

If you need help or have any questions, please open an issue or contact us at eng.gabrielscardoso@gmail.com.

Acknowledgements

We appreciate your contributions and efforts to improve our project. Thank you for being a part of our community!