We appreciate your interest in contributing to the S3 Bucket Manager project! To ensure a smooth contribution process, please follow the guidelines outlined below.
-
Fork the Repository: Start by forking the repository on GitHub. This will create a copy of the project under your GitHub account.
-
Clone Your Fork: Clone your forked repository to your local machine using the following command:
git clone https://github.com/your-username/s3-bucket-manager.git
-
Create a New Branch: Before making any changes, create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
-
Make Your Changes: Implement your changes in the codebase. Ensure that your code adheres to the project's coding standards and conventions.
-
Write Tests: If you are adding new features or fixing bugs, please include tests to cover your changes. This helps maintain the integrity of the project.
-
Run Tests: Before submitting your changes, run the tests to ensure everything is working correctly:
composer test -
Commit Your Changes: Once you are satisfied with your changes, commit them with a clear and concise commit message:
git commit -m "Add a brief description of your changes" -
Push to Your Fork: Push your changes to your forked repository:
git push origin feature/your-feature-name
-
Create a Pull Request: Go to the original repository on GitHub and create a pull request from your forked repository. Provide a detailed description of your changes and why they should be merged.
Please adhere to the project's code of conduct. Be respectful and considerate in your interactions with other contributors.
If you encounter any issues or have suggestions for new features, please open an issue in the GitHub repository. Provide as much detail as possible to help us understand the problem or request.
Thank you for contributing to the S3 Bucket Manager project!