Contributing to Beartropy

Thank you for considering contributing to Beartropy! We welcome contributions from everyone.

Getting Started

To get started with contributing, we recommend the following workflow:

1. Fork the repository you want to contribute to.
2. Clone your fork to your local machine:

   git clone https://github.com/your-username/package-name.git

3. Install dependencies using Composer based on the package instructions.

Development Workflow

We use a standard Git flow. Please follow these steps:

• Create a new branch for your feature or bug fix:

  git checkout -b my-new-feature

• Make your changes and commit them with descriptive messages.
• Push your branch to your fork.

Coding Standards

We follow the PSR-12 (and evolving PER) coding standards.

Please ensure your code is formatted correctly before submitting. Many of our packages include tools like Laravel Pint or PHP CS Fixer configuration to help with this.

Testing

Before submitting your changes, please run the test suite to ensure nothing is broken and your new feature works as expected.

composer test

If you are adding a new feature, please include tests for it.

Submission

Once you are ready, submit a Pull Request to the `main` branch of the original repository.

• Provide a clear description of what your PR does.
• Link to any related issues.
• Be patient! We will review your PR as soon as possible.

Thank you for making Beartropy better!