Create CONTRIBUTING file #139
Conversation
This is a boilerplate that needs to be enhanced
| --> | ||
|
|
||
| ## Styleguides | ||
| ### Commit Messages |
There was a problem hiding this comment.
I've been using this style for a while and it works super well:
There was a problem hiding this comment.
Especially when combined with a rebase/interactive rebase. The history becomes super clean 😊 Almost like a mind map or a guide 😄
|
|
||
| ## I Have a Question | ||
|
|
||
| > If you want to ask a question, we assume that you have read the available [Documentation](). |
There was a problem hiding this comment.
Hah - maybe let's take the link out for now.
|
|
||
| If you then still feel the need to ask a question and need clarification, we recommend the following: | ||
|
|
||
| - Open an [Issue](https://github.com/MewsSystems/FuncSharp/issues/new). |
There was a problem hiding this comment.
Speaking of - we should have an issue template.
| <!-- | ||
| You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly. | ||
|
|
||
| Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities: | ||
| - IRC | ||
| - Slack | ||
| - Gitter | ||
| - Stack Overflow tag | ||
| - Blog | ||
| - FAQ | ||
| - Roadmap | ||
| - E-Mail List | ||
| - Forum | ||
| --> |
There was a problem hiding this comment.
Yeah I don't think we'd need this section in the near future.
| A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)). |
| > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>. | ||
| <!-- You may add a PGP key to allow the messages to be sent encrypted as well. --> |
There was a problem hiding this comment.
I'd simplify
| > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>. | |
| <!-- You may add a PGP key to allow the messages to be sent encrypted as well. --> | |
| > Make sure not to include sensitive information when asking questions or submitting bugs anywhere in public. |
|
|
||
| #### Environment setup | ||
|
|
||
| All You need is a .NET 6 SDK, an IDE of your choice and you're good to go! 🎉 |
There was a problem hiding this comment.
Actually, you need an IDE capable of executing T4 scripts.
Unfortunately even rider itself is not capable of running the T4 scripts. You'd need to get the dlls from microsoft to make it work. I solved this by also installing visual studio and simply not using it.
|
|
||
| ``` | ||
| "This commit will <YOUR_COMMIT_MESSAGE>" | ||
| ``` | ||
| serving as a clear template. For instance, a commit could be `"This commit will <Introduce new data type>"`, providing a concise insight into the purpose of the commit. |
There was a problem hiding this comment.
I wouldn't have the This commit will prefix - You even don't have it in the screenshot 😄
closes #138
Summary
Maintaining an open-source project is not too difficult, but it has to be done properly and people need to know how to contribute. This PR introduces a
CONTRIBUTING.MD, which is a very common practice for open-source repositories.Solution