-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Creating contributing from Service Signed-off-by: Diana <dmoore@xn4p4lm.com>
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Contributing to Bot-O-Cat | ||
|
||
Thank you for your interest in contributing to Bot-O-Cat! We welcome contributions from the community to help improve our project. Before you get started, please take a moment to review the guidelines below. | ||
|
||
## Development Environment | ||
|
||
To ensure a consistent development environment, we highly recommend using the included devcontainer for development. The devcontainer provides a pre-configured development environment with all the necessary dependencies and tools. | ||
|
||
To use the devcontainer, follow these steps: | ||
|
||
1. Fork the Bot-O-Cat repository to your own GitHub account. | ||
1. Install Docker on your machine if you haven't already. | ||
1. Clone the Bot-O-Cat repository to your local machine. | ||
1. Open the project in your preferred code editor. | ||
1. If prompted, allow the editor to reopen the project in a container. | ||
1. Wait for the devcontainer to build and start. | ||
|
||
By using the devcontainer, you can avoid issues related to different development environments and ensure that your contributions are consistent with the project's standards. | ||
|
||
The offically supported code editor is **Visual Studio Code**. If you are using another code editor, you may need to install additional extensions or tools to use the devcontainer and may encounter issues. | ||
|
||
## Contributing Guidelines | ||
|
||
When contributing to Bot-O-Cat, please keep the following guidelines in mind: | ||
|
||
- Before starting work on a new feature or bug fix, please create an issue to discuss the proposed changes with the maintainers. | ||
- Fork the repository and create a new branch for your changes. | ||
- Make sure your code follows the project's coding style and conventions. | ||
- Write clear and concise commit messages. | ||
- Test your changes thoroughly and ensure that existing tests pass. | ||
- Submit a pull request with your changes, providing a detailed description of the changes made. | ||
- Ensure that when submitting code that you have read the [developer-certificate-of-origin](developer-certificate-of-origin) and that you have signed off on your commits with `git commit -s` or `git commit --signoff`. | ||
|
||
## Code of Conduct | ||
|
||
Please note that Bot-O-Cat has a [Code of Conduct](CONTRIBUTING.MD). By participating in this project, you are expected to uphold the code of conduct and treat all contributors with respect. | ||
|
||
## Getting Help | ||
|
||
If you have any questions or need assistance, feel free to reach out to the maintainers or the community. We are here to help! | ||
|
||
Thank you for your contributions and happy coding! |