From 4fc9291e204663fbef6450f827a1b339acf06724 Mon Sep 17 00:00:00 2001 From: Tegar Imansyah Date: Thu, 29 Jun 2023 11:53:23 +0700 Subject: [PATCH] feat: update readme and.add contributing --- CONTRIBUTING.md | 15 +++++++++++++++ README.md | 10 +++++----- 2 files changed, 20 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f48a67b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +First and foremost, thanks for your interest in contributing to Github Declutter! Please take a moment to review this document **before** submitting a pull request. + +## Find or Create an Issue + +Please get in touch with maintainers to discuss about your great idea, whether it's a bug fixing or new feature. You can also looking for existing issues and find one that suits you, then ask the maintainer if you want to do that and share your idea. We are really welcome you and will assign you for that issue! + +## Fork and Run It on Your Own + +You can fork this repo, do your experiments and then create a Pull Request. Please also add the link to the issue in the description and we will talk a lot there. + +While you are at your code editor, make sure you also using our eslintrc and prettierrc so the coding standard will still intact. + +If you are the first-timer contributor, please don't hesitate to ask maintainer for explaining any term that you are not familiar with. \ No newline at end of file diff --git a/README.md b/README.md index 1719012..77bc00d 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,13 @@ $ npm run dev -- --host ## Contribution -* Bug report -> Create issue -* Feature request -> Create issue -* Ask something? -> Create issue or mention @tegar_imansyah in twitter -* Code contribution -> Read CONTRIBUTING.md +* Bug report -> [Create Bug report issue](https://github.com/tegarimansyah/github_declutter/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=) +* Feature request -> [Create Feature Request issue](https://github.com/tegarimansyah/github_declutter/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=) +* Ask something? -> [Create issue](https://github.com/tegarimansyah/github_declutter/issues/new) or [mention @tegar_imansyah in twitter](https://twitter.com/intent/tweet?text=@tegar_imansyah%20github-declutter.tegar.my.id) +* Code contribution -> Read [CONTRIBUTING.md](CONTRIBUTING.md) ## Find it helpful? -* Share your story to your social media. Please also let me know by mentioning @tegar_imansyah or fill this form. +* Share your story to your social media. Please also let me know by mentioning [@tegar_imansyah](https://twitter.com/intent/tweet?text=@tegar_imansyah%20github-declutter.tegar.my.id) and I will share your story in our use case. ## License: MIT \ No newline at end of file