From 2a7fd18cf2959866d10533cc15e896cfaaae8c7c Mon Sep 17 00:00:00 2001 From: hiron Date: Sat, 23 Apr 2022 18:40:07 +0900 Subject: [PATCH] Add contributing.md --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..21ed47c0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# How to contribute + +👍🎉 First off, thanks for taking the time to contribute! 🎉👍 + +The following is a set of guidelines for contributing to this component. +These are mostly guidelines, not rules. +Use your best judgment, and feel free to propose changes to this document in a pull request. + +## Note! + +Writing code and suggesting fixes is not the only way to contribute! +Your comments, problems, and opinions posted in [Discussion](https://github.com/hrntsm/HoaryFox/discussions) or [Issues](https://github.com/hrntsm/HoaryFox/issues) are one aspect of contribution. + +Feel free to post it. + +## Submitting changes + +Please send a [GitHub Pull Request](https://github.com/hrntsm/HoaryFox/pull/new/main) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). +When you send a pull request, we will love you forever if you include examples. +Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit). + +Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this: + + $ git commit -m "A brief summary of the commit + > + > A paragraph describing what changed and its impact." + +## Coding conventions + +Start reading our code and you'll get the hang of it. +Please check your .editorconfig file and code accordingly and format it with `dotnet format` commands. + +Thanks, +hrntsm