From 32125979ce3dac0456c3abbd6c3d85cf88385aeb Mon Sep 17 00:00:00 2001 From: Mikael Fangel <34864484+MikaelFangel@users.noreply.github.com> Date: Wed, 29 May 2024 20:30:45 +0000 Subject: [PATCH] contributing: add (#17) --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2e4d7b0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing + +Thank you for considering contributing to our project! We appreciate your time and effort. To ensure a smooth collaboration process, please follow these guidelines when creating issues or pull requests. + +## Creating Good Issues or Pull Requests + +### Issues + - Before creating an issue, search the existing issues to avoid duplicates. + - Clearly describe the problem or feature request. + - Include relevant details such as steps to reproduce, expected behavior, and actual behavior. + +### Pull Requests + - Fork the repository and create a new branch for your changes. + - Make the pull request a small as possible. + - Write clear commit messages. + - Include tests if applicable. + +## Community and Behavioral Expectations + +### Be Respectful + - Treat others with kindness and respect. + - Avoid offensive language or behavior. + -Listen actively and consider different perspectives. + +### Collaborate +- Work together to achieve common goals. +- Provide constructive feedback. +- Encourage new contributors.