-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b39eb3d
commit 83ea8c0
Showing
1 changed file
with
24 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,28 @@ | ||
Contributing to BumbleDocGen | ||
Welcome to BumbleDocGen! We're glad you're interested in contributing. Please follow the guidelines below to ensure your contributions align with our coding standards and practices. | ||
|
||
Code Style | ||
We follow the PSR-12 coding standard to maintain consistent and readable code across the project. Before submitting any code changes, please make sure your code adheres to this standard. | ||
|
||
How to Contribute | ||
Fork the repository and create a new branch for your contributions. | ||
Clone your forked repository to your local machine. | ||
Make your code changes, following the PSR-12 coding standard. | ||
Commit your changes with clear and descriptive commit messages. | ||
Push your changes to your forked repository. | ||
Create a pull request (PR) to the main repository. | ||
Our team will review your PR, provide feedback, and work with you to address any concerns. | ||
Once the PR is approved, your code will be merged into the project. | ||
Code Review | ||
# Contributing to **BumbleDocGen** | ||
|
||
Welcome to `BumbleDocGen`! We're glad you're interested in contributing. Please follow the guidelines below to ensure your contributions align with our coding standards and practices. | ||
|
||
## Code Style | ||
|
||
We follow the [PSR-12 coding standard](https://www.php-fig.org/psr/psr-12/) to maintain consistent and readable code across the project. Before submitting any code changes, please make sure your code adheres to this standard. | ||
|
||
## How to Contribute | ||
|
||
1. Fork the repository and create a new branch for your contributions. | ||
2. Clone your forked repository to your local machine. | ||
3. Make your code changes, following the PSR-12 coding standard. | ||
4. Commit your changes with clear and descriptive commit messages. | ||
5. Push your changes to your forked repository. | ||
6. Create a pull request (PR) to the main repository. | ||
7. Our team will review your PR, provide feedback, and work with you to address any concerns. | ||
8. Once the PR is approved, your code will be merged into the project. | ||
|
||
## Code Review | ||
|
||
During the code review process, our team will ensure that your contributions meet our quality and style standards. If there are any changes or improvements needed, we'll provide feedback in the PR comments. Your willingness to address these suggestions will help us maintain the high quality of our codebase. | ||
|
||
Getting Help | ||
## Getting Help | ||
|
||
If you have any questions or need assistance with your contributions, feel free to reach out by [creating an issue](https://github.com/bumble-tech/bumble-doc-gen/issues). | ||
|
||
Thank you for contributing to BumbleDocGen and helping us improve our codebase! | ||
Thank you for contributing to `BumbleDocGen` and helping us improve our codebase! |