Skip to content

Commit f55c105

Browse files
EbaaCodeEbaaCode
committed
✨ | Added .github folder.
1 parent e0946a2 commit f55c105

File tree

2 files changed

+178
-0
lines changed

2 files changed

+178
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Code of Conduct - Djs-v13-bot-template
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* ublic or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at Contact method. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
44+
## Attribution
45+
46+
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
47+
48+
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
49+
50+
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

‎.github/CONTRIBUTING.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
<!-- omit in toc -->
2+
# Contributing to Djs-v13-bot-template
3+
4+
First off, thanks for taking the time to contribute! ❤️
5+
6+
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. 🎉
7+
8+
> 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:
9+
> - Star the project
10+
> - Tweet about it
11+
> - Refer this project in your project's readme
12+
> - Mention the project at local meetups and tell your friends/colleagues
13+
14+
<!-- omit in toc -->
15+
## Table of Contents
16+
17+
- [Code of Conduct](#code-of-conduct)
18+
- [I Have a Question](#i-have-a-question)
19+
- [I Want To Contribute](#i-want-to-contribute)
20+
- [Reporting Bugs](#reporting-bugs)
21+
- [Suggesting Enhancements](#suggesting-enhancements)
22+
23+
24+
## Code of Conduct
25+
26+
This project and everyone participating in it is governed by the
27+
[Djs-v13-bot-template Code of Conduct](CODE_OF_CONDUCT.md).
28+
By participating, you are expected to uphold this code.
29+
30+
31+
## I Have a Question
32+
33+
Before you ask a question, it is best to search for existing [Issues](https://github.com/EbaaCode/Djs-v13-bot-template/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
34+
35+
If you then still feel the need to ask a question and need clarification, we recommend the following:
36+
37+
- Open an [Issue](https://github.com/EbaaCode/Djs-v13-bot-template/issues/new).
38+
- Provide as much context as you can about what you're running into.
39+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
40+
41+
We will then take care of the issue as soon as possible.
42+
43+
<!--
44+
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
45+
46+
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:
47+
- IRC
48+
- Slack
49+
- Gitter
50+
- Stack Overflow tag
51+
- Blog
52+
- FAQ
53+
- Roadmap
54+
- E-Mail List
55+
- Forum
56+
-->
57+
58+
## I Want To Contribute
59+
60+
> ### Legal Notice <!-- omit in toc -->
61+
> 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.
62+
63+
### Reporting Bugs
64+
65+
<!-- omit in toc -->
66+
#### Before Submitting a Bug Report
67+
68+
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.
69+
70+
- Make sure that you are using the latest version.
71+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions.
72+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/EbaaCode/Djs-v13-bot-templateissues?q=label%3Abug).
73+
- Also make sure to search the internet to see if users outside of the GitHub community have discussed the issue.
74+
- Collect information about the bug:
75+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
76+
- Possibly your input and the output
77+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
78+
79+
<!-- omit in toc -->
80+
#### How Do I Submit a Good Bug Report?
81+
82+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public.
83+
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
84+
85+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
86+
87+
- Open an [Issue](https://github.com/EbaaCode/Djs-v13-bot-template/issues/new).
88+
- Explain the behavior you would expect and the actual behavior.
89+
- 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.
90+
- Provide the information you collected in the previous section.
91+
92+
Once it's filed:
93+
94+
- The project team will label the issue accordingly.
95+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
96+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be implemented by someone.
97+
98+
<!-- 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. -->
99+
100+
101+
### Suggesting Enhancements
102+
103+
This section guides you through submitting an enhancement suggestion for Djs-v13-bot-template, **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.
104+
105+
<!-- omit in toc -->
106+
#### Before Submitting an Enhancement
107+
108+
- Make sure that you are using the latest version.
109+
- Perform a [search](https://github.com/EbaaCode/Djs-v13-bot-template/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
110+
111+
112+
<!-- omit in toc -->
113+
#### How Do I Submit a Good Enhancement Suggestion?
114+
115+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/EbaaCode/Djs-v13-bot-template/issues).
116+
117+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
118+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
119+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
120+
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. <!-- this should only be included if the project has a GUI -->
121+
- **Explain why this enhancement would be useful** to most Djs-v13-bot-template users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
122+
123+
<!-- 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. -->
124+
125+
---
126+
<!-- omit in toc -->
127+
## Attribution
128+
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

0 commit comments

Comments
 (0)