From fe19e66ae50dc66f132e113cf8eadf64ed377568 Mon Sep 17 00:00:00 2001 From: Diana Date: Sun, 28 Apr 2024 17:10:33 -0700 Subject: [PATCH] Create CONTRIBUTING.MD Creating contributing from Service Signed-off-by: Diana --- CONTRIBUTING.MD | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 CONTRIBUTING.MD diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD new file mode 100644 index 0000000..41eda8c --- /dev/null +++ b/CONTRIBUTING.MD @@ -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!