Skip to content

Commit

Permalink
feat: update readme and.add contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
tegarimansyah authored Jun 29, 2023
1 parent 31e3b88 commit 4fc9291
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

1 comment on commit 4fc9291

@vercel
Copy link

@vercel vercel bot commented on 4fc9291 Jun 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.