From 31dea94f54c31276d41d866182b51d777d654bb8 Mon Sep 17 00:00:00 2001 From: nadavSoluto Date: Sun, 10 Jul 2022 21:54:54 +0300 Subject: [PATCH 1/4] contribution file alignment --- CONTRIBUTING.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..80c0afe2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,65 @@ +# Contributing to Kamus + +Welcome, and thank you for your interest in contributing to Kamus! + +There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved. + +## Asking Questions + +Have a question? Rather than opening an issue, please ask away on [Stack Overflow](https://stackoverflow.com/) using the a related tag + +The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help. + +## Providing Feedback + +Your comments and feedback are welcome, and the development team is available via a handful of different channels: + +- GitHub issues +- Any related slack channels or stackoverflow + +## Reporting Issues + +Have you identified a reproducible problem in Kamus? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible. + +### Look For an Existing Issue + +Before you create a new issue, please do a search in (https://github.com/Soluto/kamus/issues) to see if the issue or feature request has already been filed. + +If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below. + +### Writing Good Bug Reports and Feature Requests + +File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue. + +Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. + +The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix. + +Please include the following with each issue: + +- Version of Kamus +- Your operating system +- Reproducible steps (1... 2... 3...) that cause the issue +- What you expected to see, versus what you actually saw +- Images, animations, or a link to a video showing the issue occurring +- A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally + - **Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient. + +### Final Checklist + +Please remember to do the following: + +- [ ] Search the issue repository to ensure your report is a new issue +- [ ] Simplify your code around the issue to better isolate the problem + +Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information! + +## Contributing Fixes + +There are many ways to contribute to the Kamus project: logging bugs, submitting pull requests, reporting issues, and creating suggestions. + +After cloning and building the repo, check out the issues list. Issues labeled `help wanted` are good issues to submit a PR for. Issues labeled `good first issue` are great candidates to pick up if you are in the code for the first time. If you are contributing significant changes, or if the issue is already assigned to a specific month milestone, please discuss with the issue assignee first before starting to work on the issue + +# Thank You! + +Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute. \ No newline at end of file From b070bf1f831eec22fbb783bc2d12058d0f444417 Mon Sep 17 00:00:00 2001 From: nadavSoluto Date: Mon, 11 Jul 2022 08:48:43 +0300 Subject: [PATCH 2/4] link fix --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80c0afe2..ef86b6cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Have you identified a reproducible problem in Kamus? Have a feature request? We ### Look For an Existing Issue -Before you create a new issue, please do a search in (https://github.com/Soluto/kamus/issues) to see if the issue or feature request has already been filed. +Before you create a new issue, please do a search in [open issues](https://github.com/Soluto/kamus/issues) to see if the issue or feature request has already been filed. If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below. From aa9483f8287a0f82d8fd74a2087026db5cca1fcf Mon Sep 17 00:00:00 2001 From: nadavSoluto Date: Tue, 12 Jul 2022 21:30:08 +0300 Subject: [PATCH 3/4] readme contribute link --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 85d89cef..ce93fa76 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,7 @@ In case you find a security issue or have something you would like to discuss re ## Contributing Found a bug? Have a missing feature? Please open an issue and let us know. +please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) policy for more information We would like to help you use Kamus! Please notice: Do not report security issues on GitHub. We will immediately delete such issues. From 7b484cff4273249337887718874f3be79de4265d Mon Sep 17 00:00:00 2001 From: Giora Guttsait Date: Wed, 13 Jul 2022 11:38:55 +0300 Subject: [PATCH 4/4] chore: trigger ci