diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..03d8c6b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,99 @@ + +# Contributing to Sidekick + +Thank you for your interest in contributing to Sidekick! I appreciate your support and contributions, whether it's reporting bugs, improving documentation, submitting enhancements, or helping out with the code. + +## How to Contribute + +### 1. Fork the Repository + +- Start by [forking](https://github.com/PapaRascal2020/sidekick/fork) the repository. +- Clone your forked repository to your local machine: + + ```bash + git clone https://github.com/your-username/sidekick.git + cd sidekick + ``` + +- Add the original repository as a remote upstream: + + ```bash + git remote add upstream https://github.com/PapaRascal2020/sidekick.git + ``` + +### 2. Create a Branch + +- Before starting your work, create a new branch: + + ```bash + git checkout -b feature/your-feature-name + ``` + + Use a descriptive branch name, such as `feature/new-api-integration` or `bugfix/fix-error-handling`. + +### 3. Make Your Changes + +- Make sure your code follows the project's coding standards and best practices. + +### 4. Commit Your Changes + +- Commit your changes with a meaningful commit message: + + ```bash + git commit -m "Add new feature for XYZ" + ``` + +- Please make sure to reference any related issues in your commit messages (e.g., `Fixes #123`). + +### 5. Push Your Changes + +- Push your changes to your forked repository: + + ```bash + git push origin feature/your-feature-name + ``` + +### 6. Open a Pull Request + +- Go to the [original repository](https://github.com/PapaRascal2020/sidekick) and open a pull request. +- Provide a clear and descriptive title for your pull request. +- In the pull request description, explain the changes you've made and the problem you're solving. Include any relevant issue numbers. +- Make sure to select the appropriate labels for your pull request. + +### 7. Code Review Process + +- One of the maintainers will review your pull request. We aim to provide feedback within a few days. +- Please respond to feedback by making the necessary changes and pushing the updates to your branch. +- Once your pull request is approved, it will be merged into the main branch. + +## Guidelines + +### Reporting Bugs + +If you find a bug, please open an issue [here](https://github.com/PapaRascal2020/sidekick/issues) with the following details: + +- **Summary**: A clear and concise description of the bug. +- **Steps to Reproduce**: What steps you took to encounter the issue. +- **Expected Behavior**: What you expected to happen. +- **Actual Behavior**: What actually happened. +- **Environment**: Your environment (PHP version, Laravel version, etc.). + +### Suggesting Enhancements + +We welcome any feature requests or enhancements. To suggest an enhancement, please open an issue [here](https://github.com/PapaRascal2020/sidekick/issues) with the following details: + +- **Description**: A detailed explanation of the enhancement. +- **Use Case**: Why you believe this feature will be useful. +- **Potential Alternatives**: Any alternative solutions or features you've considered. + +### Pull Request Best Practices + +- Keep your changes focused and avoid bundling unrelated changes into a single pull request. +- Document any new public methods or classes you introduce. +- Follow the existing code style and structure. Consistency is key! + +## Get in Touch + +If you have any questions or need help, feel free to reach out by opening an issue or starting a discussion on our [GitHub Discussions](https://github.com/PapaRascal2020/sidekick/discussions) page. + +Thank you for contributing!