Skip to content

Commit e7b71d2

Browse files
Create CONTRIBUTING.md
1 parent 519b8ce commit e7b71d2

File tree

1 file changed

+98
-0
lines changed

1 file changed

+98
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
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/webdevnerdstuff/vue-easter-egg-trigger/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/webdevnerdstuff/vue-easter-egg-trigger/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+
23+
### Open a pull request
24+
When you're done making changes and you'd like to propose them for review, open your PR (pull request).
25+
26+
### Submit your PR & get it reviewed
27+
- Once you submit your PR, others from the Vue Easter Egg Trigger community will review it with you.
28+
- After that, we may have questions, check back on your PR to keep up with the conversation.
29+
30+
### Your PR is merged!
31+
Congratulations! The whole GitHub community thanks you. :sparkles:
32+
33+
Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/graphs/contributors).
34+
35+
### Keep contributing as you use Vue Easter Egg Trigger
36+
37+
Now that you're a part of the Vue Easter Egg Trigger community, you can keep participating in many ways.
38+
39+
## Types of contributions
40+
You can contribute to the Vue Easter Egg Trigger content and site in several ways. This repo is a place to discuss and collaborate on Vue Easter Egg Trigger! Our small, but mighty team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
41+
42+
### :mega: Discussions
43+
Discussions are where we have conversations.
44+
45+
If you'd like help troubleshooting a Vue Easter Egg Trigger 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/webdevnerdstuff/vue-easter-egg-trigger/discussions).
46+
47+
### :beetle: Issues
48+
[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with.
49+
50+
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/webdevnerdstuff/vue-easter-egg-trigger/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
51+
52+
### :hammer_and_wrench: Pull requests
53+
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.
54+
55+
To learn more about opening a pull request in this repo, see [Opening a pull request](#opening-a-pull-request) below.
56+
57+
### :question: Support
58+
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.
59+
60+
If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact).
61+
62+
## Starting with an issue
63+
You can browse existing issues to find something that needs help!
64+
65+
### Labels
66+
Labels can help you find an issue you'd like to help with.
67+
68+
- The [`help wanted` label](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for problems or updates that anyone in the community can start working on.
69+
- The [`documentation` label](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) is for problems or updates relating to the README.MD documentation.
70+
- The [`bug` label](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues?q=is%3Aopen+is%3Aissue+label%3Abug) is for problems with the code and bugs.
71+
- The [`enhancement` label](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for
72+
suggestions to improve the code or adding of additional features.
73+
74+
## Opening a pull request
75+
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.
76+
77+
## Working in the Vue Easter Egg Trigger repository
78+
Here's some information that might be helpful while working on a Vue Easter Egg Trigger PR:
79+
80+
<!-- - [Development](/contributing/development.md) - This short guide describes how to get this app running on your local machine. -->
81+
82+
## Reviewing
83+
We (usually the Vue Easter Egg Trigger team) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub.
84+
85+
- Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.
86+
- Reviews discuss content, not the person who created it.
87+
- Reviews are constructive and start conversation around feedback.
88+
89+
### Self review
90+
You should always review your own PR first.
91+
92+
<!-- ### Pull request template
93+
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. -->
94+
95+
### Suggested changes
96+
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.
97+
98+
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

Comments
 (0)