|
| 1 | +# Contributing to this repository <!-- omit in toc --> |
| 2 | + |
| 3 | +## Getting started <!-- omit in toc --> |
| 4 | + |
| 5 | +Before you begin: |
| 6 | +- Have you read the [code of conduct](CODE_OF_CONDUCT.md)? |
| 7 | +- Check out the [existing issues](https://github.com/__USERNAME__/vuetify-plugin-template/issues). |
| 8 | + |
| 9 | +### Don't see your issue? Open one |
| 10 | + |
| 11 | +If you spot something new, open an issue using a [template](https://github.com/__USERNAME__/vuetify-plugin-template/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. |
| 12 | + |
| 13 | +### Ready to make a change? Fork the repo |
| 14 | + |
| 15 | +Fork using the command line: |
| 16 | + |
| 17 | +- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. |
| 18 | + |
| 19 | +### Make your update: |
| 20 | + |
| 21 | +Make your changes to the file(s) you'd like to update. |
| 22 | +Update the CHANGELOG.md with the updates you made, please include the date and Github username. |
| 23 | + |
| 24 | +### Open a pull request |
| 25 | +When you're done making changes and you'd like to propose them for review, open your PR (pull request). |
| 26 | + |
| 27 | +### Submit your PR & get it reviewed |
| 28 | +- Once you submit your PR, others from the Vue Unicorn Log community will review it with you. |
| 29 | +- After that, we may have questions, check back on your PR to keep up with the conversation. |
| 30 | + |
| 31 | +### Your PR is merged! |
| 32 | +Congratulations! The whole GitHub community thanks you. :sparkles: |
| 33 | + |
| 34 | +Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/__USERNAME__/vuetify-plugin-template/graphs/contributors). |
| 35 | + |
| 36 | +### Keep contributing as you use Vue Unicorn Log |
| 37 | + |
| 38 | +Now that you're a part of the Vue Unicorn Log community, you can keep participating in many ways. |
| 39 | + |
| 40 | +## Types of contributions |
| 41 | +You can contribute to the Vue Unicorn Log content and site in several ways. This repo is a place to discuss and collaborate on Vue Unicorn Log! Our small, but mighty team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed. |
| 42 | + |
| 43 | +### :mega: Discussions |
| 44 | +Discussions are where we have conversations. |
| 45 | + |
| 46 | +If you'd like help troubleshooting a Vue Unicorn Log PR you're working on, have a great new idea, or want to share something amazing you've learned, join us in [discussions](https://github.com/__USERNAME__/vuetify-plugin-template/discussions). |
| 47 | + |
| 48 | +### :beetle: Issues |
| 49 | +[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with. |
| 50 | + |
| 51 | +If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/__USERNAME__/vuetify-plugin-template/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. |
| 52 | + |
| 53 | +### :hammer_and_wrench: Pull requests |
| 54 | +A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository. |
| 55 | + |
| 56 | +To learn more about opening a pull request in this repo, see [Opening a pull request](#opening-a-pull-request) below. |
| 57 | + |
| 58 | +### :question: Support |
| 59 | +We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with GitHub, unrelated to our documentation, please [contact GitHub Support directly](https://support.github.com/contact). Any issues, discussions, or pull requests opened here requesting support will be given information about how to contact GitHub Support, then closed and locked. |
| 60 | + |
| 61 | +If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). |
| 62 | + |
| 63 | +## Starting with an issue |
| 64 | +You can browse existing issues to find something that needs help! |
| 65 | + |
| 66 | +### Labels |
| 67 | +Labels can help you find an issue you'd like to help with. |
| 68 | + |
| 69 | +- The [`help wanted` label](https://github.com/__USERNAME__/vuetify-plugin-template/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for problems or updates that anyone in the community can start working on. |
| 70 | +- The [`documentation` label](https://github.com/__USERNAME__/vuetify-plugin-template/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) is for problems or updates relating to the README.MD documentation. |
| 71 | +- The [`bug` label](https://github.com/__USERNAME__/vuetify-plugin-template/issues?q=is%3Aopen+is%3Aissue+label%3Abug) is for problems with the code and bugs. |
| 72 | +- The [`enhancement` label](https://github.com/__USERNAME__/vuetify-plugin-template/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for |
| 73 | +suggestions to improve the code or adding of additional features. |
| 74 | + |
| 75 | +## Opening a pull request |
| 76 | +You can use the GitHub user interface for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine. |
| 77 | + |
| 78 | +## Working in the Vue Unicorn Log repository |
| 79 | +Here's some information that might be helpful while working on a Vue Unicorn Log PR: |
| 80 | + |
| 81 | +<!-- - [Development](/contributing/development.md) - This short guide describes how to get this app running on your local machine. --> |
| 82 | + |
| 83 | +## Reviewing |
| 84 | +We (usually the Vue Unicorn Log team) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub. |
| 85 | + |
| 86 | +- Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time. |
| 87 | +- Reviews discuss content, not the person who created it. |
| 88 | +- Reviews are constructive and start conversation around feedback. |
| 89 | + |
| 90 | +### Self review |
| 91 | +You should always review your own PR first. |
| 92 | + |
| 93 | +<!-- ### Pull request template |
| 94 | +When you open a pull request, you must fill out the "Ready for review" template before we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request. --> |
| 95 | + |
| 96 | +### Suggested changes |
| 97 | +We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. |
| 98 | + |
| 99 | +As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). |
0 commit comments