diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e25f1e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Create a report to help us improve. +title: '' +labels: '' +assignees: '' + +--- + +### Describe the bug +A clear and concise description of what the bug is. + +### Which Blazor project type is your bug related to? + +- Client-Side +- Server-Side + +### To Reproduce +Steps to reproduce the behavior: +1. Using this version of ChartJSBlazor '...'. +2. Run this code '....'. +3. With these arguments '....'. +4. See error. + +### Expected behavior +A clear and concise description of what you expected to happen. + +### Screenshots +If applicable, add screenshots to help explain your problem. + +### Additional context / logging +Add any other context about the problem here. + + + +```batch +\\ Put your error log here +``` +### Code example +Please provide full code examples below where possible to make it easier for the developers to check your issues. + +```csharp +\\ Put your example code here +``` \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..932760a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Suggest an idea for this project. +title: '' +labels: '' +assignees: '' + +--- + +### Describe the feature request +Is your feature request related to a problem? Please describe. +A clear and concise description of what the problem is. Example. I'm am trying to do [...] but [...] + +### Which Blazor project type is your feature request related to? + +- Client-Side +- Server-Side + +### Describe the solution you'd like +A clear and concise description of what you want to happen. + +### Describe alternatives you've considered +A clear and concise description of any alternative solutions or features you've considered. + +### Additional context +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..36780e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,16 @@ +--- +name: Custom issue template +about: Do you have a question related to the project? Use this template. +title: '' +labels: '' +assignees: '' + +--- + +### Describe your question +A clear and concise description of what you want to know. + +### Which Blazor project type is your question related to? + +- Client-Side +- Server-Side \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ce00052 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# ChartJSBlazor Contributor's guide +Here is our guidance for how to propose new features and submit contributions via Pull Requests (PR). This is loosely modelled after the [microsoft/terminal](https://github.com/microsoft/terminal/blob/master/doc/contributing.md) and the [www.opensource.guide](https://opensource.guide/how-to-contribute) Guidelines + +## Before you start, file an issue +To eliminate unnecessary effort and frustration and to ensure no one wastes time please file an issue before doing anything else. + +### How to file an issue +Before filing a new issue, please look through already existing issues. Search open and closed issues first, it may be that someone else has already found the problem you have and has filed an issue. Please don't clutter up the repo with duplicate issues. + +If no existing issue describes the problem/ feature idea you have: Great! - please file a new issue + +### File a new Issue +- Have a question that you don't see answered in our (sparse) documentation? File an issue +- Want to know if we're planning on implementing a new feature? File an issue +- Got a great idea for a new feature? File an issue +- Found an existing issue that describes yours? Great - upvote and add additional commentary/ info/ repro-steps/ etc. + +### Flesh out your issue +This is based off of [Section 5 of the opensource guide to contributing](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) + +- **Give Context** help us help you by giving context to the why/ how of your issue +- **Do some research beforehand** Not knowing everything is ok but show that you tried. Please don't ask questions we can answer with a simple google search or with a link to another issue +- **Keep them short and direct** The shorter and more direct an issue is, the faster we can understand it and help you +- **Ask questions** Everyone starts out not knowing anything about a project, don't be afraid to ask us well researched questions +- **Above all be nice and respectful** + +## Contributing fixes and features +For those able and willing to help fix issues and/ or implement features: + +### Development +### Fork, Clone, Branch and Create your PR +Once you have created an issue, discussed the issue with other contributors and the maintainer and you have agreed on an approach, it is time to start development: + +1. Fork the repo (if you haven't already) +2. Clone your fork locally +3. Create & push a feature branch +4. Rebase onto master to eliminate merge conflicts (if you're unsure what a rebase is, [here](https://hackernoon.com/dont-fear-the-rebase-bca683888dae) is an excellent blog post) +5. Create a Pull Request + +After this process, your PR will be reviewed by the Maintainer and either be accepted, merged into master and closed or be rejected with comments and instructions on improvements and fixes \ No newline at end of file diff --git a/README.md b/README.md index d0d54a3..bd6142b 100644 --- a/README.md +++ b/README.md @@ -126,5 +126,8 @@ or this code if you want the bundled version of `Chart.Js`, but without the loca * [SeppPenner](https://github.com/SeppPenner) * [MindSwipe](https://github.com/MindSwipe) +# Contributing +We really like people helping us with the project. Nevertheless, take your time to read our contributing guidelines [here](https://github.com/Joelius300/ChartJSBlazor/blob/master/CONTRIBUTING.md). + # License [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Joelius300/ChartJSBlazor/blob/master/LICENSE.md)