Skip to content

Commit

Permalink
Add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hrntsm committed Apr 23, 2022
1 parent 611871c commit 2a7fd18
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2a7fd18

Please sign in to comment.