-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cedbfe8
commit 40db281
Showing
18 changed files
with
152 additions
and
149 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,13 @@ | ||
{ | ||
"env": { | ||
"browser": true, | ||
"es2021": true | ||
}, | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:vue/essential" | ||
], | ||
"parserOptions": { | ||
"ecmaVersion": 13, | ||
"sourceType": "module" | ||
}, | ||
"plugins": [ | ||
"vue" | ||
], | ||
"rules": { | ||
} | ||
"env": { | ||
"browser": true, | ||
"es2021": true | ||
}, | ||
"extends": ["eslint:recommended", "plugin:vue/essential"], | ||
"parserOptions": { | ||
"ecmaVersion": 13, | ||
"sourceType": "module" | ||
}, | ||
"plugins": ["vue"], | ||
"rules": {} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,20 @@ | ||
<!-- omit in toc --> | ||
|
||
# Contributing to Vue 3 Maquee | ||
|
||
First off, thanks for taking the time to contribute! ❤️ | ||
|
||
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 | ||
|
||
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: | ||
> | ||
> - Star the project | ||
> - Tweet about it | ||
> - Refer this project in your project's readme | ||
> - Mention the project at local meetups and tell your friends/colleagues | ||
<!-- omit in toc --> | ||
|
||
## Table of Contents | ||
|
||
- [Code of Conduct](#code-of-conduct) | ||
|
@@ -25,15 +28,13 @@ All types of contributions are encouraged and valued. See the [Table of Contents | |
- [Commit Messages](#commit-messages) | ||
- [Join The Project Team](#join-the-project-team) | ||
|
||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by the | ||
[Vue 3 Maquee Code of Conduct](https://github.com/megasanjay/vue3-marquee/blob/master/CODE_OF_CONDUCT.md). | ||
By participating, you are expected to uphold this code. Please report unacceptable behavior | ||
to <[email protected]>. | ||
|
||
|
||
## I Have a Question | ||
|
||
> If you want to ask a question, we assume that you have read the available [Documentation](https://vue3-marquee.vercel.app/). | ||
|
@@ -66,11 +67,13 @@ Depending on how large the project is, you may want to outsource the questioning | |
## I Want To Contribute | ||
|
||
> ### Legal Notice <!-- omit in toc --> | ||
> | ||
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. | ||
### Reporting Bugs | ||
|
||
<!-- omit in toc --> | ||
|
||
#### Before Submitting a Bug Report | ||
|
||
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. | ||
|
@@ -87,16 +90,18 @@ A good bug report shouldn't leave others needing to chase you up for more inform | |
- Can you reliably reproduce the issue? And can you also reproduce it with older versions? | ||
|
||
<!-- omit in toc --> | ||
|
||
#### How Do I Submit a Good Bug Report? | ||
|
||
> You must never report security related issues, vulnerabilities or bugs to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <[email protected]>. | ||
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. --> | ||
|
||
We use GitHub issues to track bugs and errors. If you run into an issue with the project: | ||
|
||
- Open an [Issue](https://github.com/megasanjay/vue3-marquee/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) | ||
- Explain the behavior you would expect and the actual behavior. | ||
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. | ||
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. | ||
- Provide the information you collected in the previous section. | ||
|
||
Once it's filed: | ||
|
@@ -107,12 +112,12 @@ Once it's filed: | |
|
||
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. --> | ||
|
||
|
||
### Suggesting Enhancements | ||
|
||
This section guides you through submitting an enhancement suggestion for Vue 3 Maquee, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. | ||
|
||
<!-- omit in toc --> | ||
|
||
#### Before Submitting an Enhancement | ||
|
||
- Make sure that you are using the latest version. | ||
|
@@ -121,6 +126,7 @@ This section guides you through submitting an enhancement suggestion for Vue 3 M | |
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. | ||
|
||
<!-- omit in toc --> | ||
|
||
#### How Do I Submit a Good Enhancement Suggestion? | ||
|
||
Enhancement suggestions are tracked as [GitHub issues](https://github.com/megasanjay/vue3-marquee/issues). | ||
|
@@ -134,26 +140,33 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/megasa | |
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. --> | ||
|
||
### Your First Code Contribution | ||
|
||
<!-- TODO | ||
include Setup of env, IDE and typical getting started instructions? | ||
--> | ||
|
||
### Improving The Documentation | ||
|
||
<!-- TODO | ||
Updating, improving and correcting the documentation | ||
--> | ||
|
||
## Styleguides | ||
|
||
### Commit Messages | ||
|
||
<!-- TODO | ||
--> | ||
|
||
## Join The Project Team | ||
|
||
<!-- TODO --> | ||
|
||
<!-- omit in toc --> | ||
|
||
## Attribution | ||
|
||
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
40db281
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs: