Skip to content

Commit 59627a9

Browse files
caiovfernandescaiovfernandes
authored
📦 NEW: Add project guidelines (DNXLabs#2)
1 parent d763d5d commit 59627a9

File tree

5 files changed

+223
-0
lines changed

5 files changed

+223
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report_form.yml

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Bug Report
2+
description: File a bug report
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: input
10+
id: contact
11+
attributes:
12+
label: Contact Details (optional)
13+
description: How can we get in touch with you if we need more info?
14+
placeholder: ex. [email protected]
15+
validations:
16+
required: false
17+
- type: textarea
18+
id: what-happened
19+
attributes:
20+
label: Description. What happened?
21+
description: Also tell us, what did you expect to happen?
22+
placeholder: Tell us what you see!
23+
value: "A bug happened!"
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: steps-to-reproduce
28+
attributes:
29+
label: Steps to reproduce
30+
description: Describe the steps to reproduce.
31+
placeholder: 1. Step 1 ...
32+
2. Step 2 ...
33+
3. Step 3 ...
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: expected-behavior
38+
attributes:
39+
label: Expected behavior
40+
description: Describe the expected behavior.
41+
placeholder: The expected behavior is ...
42+
validations:
43+
required: false
44+
- type: textarea
45+
id: actual-behavior
46+
attributes:
47+
label: Actual behavior
48+
description: Describe the actual behavior.
49+
placeholder: The actual behavior is ...
50+
validations:
51+
required: true
52+
- type: dropdown
53+
id: occurrence-frequency
54+
attributes:
55+
label: Occurrence
56+
description: How often this bug occurs?
57+
options:
58+
- Frequently
59+
- Sometimes
60+
- Rarely
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: logs
65+
attributes:
66+
label: Relevant log output
67+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
68+
render: shell
69+
- type: checkboxes
70+
id: terms
71+
attributes:
72+
label: Code of Conduct
73+
description: By submitting this issue, you agree to follow our [Code of Conduct](../blob/master/CODE_OF_CONDUCT.md)
74+
options:
75+
- label: I agree to follow this project's Code of Conduct
76+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: DNX One Documentation
4+
url: https://docs.dnx.one
5+
about: At DNX we help your business build better solutions by upgrading how delivery is done, leaving behind manual processes and embracing an automated, cloud-native way of working.
6+
- name: About us
7+
url: https://dnx.solutions/about-us/
8+
about: Informations about DNX as a company.

‎.github/ISSUE_TEMPLATE/feature_request_form.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
labels: ["feature-request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this feature request!
9+
- type: input
10+
id: contact
11+
attributes:
12+
label: Contact Details (optional)
13+
description: How can we get in touch with you if we need more info?
14+
placeholder: ex. [email protected]
15+
validations:
16+
required: false
17+
- type: textarea
18+
id: summary
19+
attributes:
20+
label: Summary
21+
description: Describe the requested feature.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: motivation
26+
attributes:
27+
label: Motivation
28+
description: Describe the motivation behind this feature request.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Alternatives
35+
description: Describe the alternatives you've considered.
36+
validations:
37+
required: false
38+
- type: textarea
39+
id: additional-information
40+
attributes:
41+
label: Additional Context
42+
- type: checkboxes
43+
id: terms
44+
attributes:
45+
label: Code of Conduct
46+
description: By submitting this issue, you agree to follow our Code of Conduct](../blob/master/CODE_OF_CONDUCT.md)
47+
options:
48+
- label: I agree to follow this project's Code of Conduct
49+
required: true

‎.github/pull_request_template.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
3+
4+
## Types of changes
5+
6+
What types of changes does your code introduce to <repo_name>?
7+
_Put an `x` in the boxes that apply_
8+
9+
- [ ] Bugfix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation Update (if none of the other choices apply)
13+
14+
## Checklist
15+
16+
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
17+
18+
- [ ] I have read the CONTRIBUTING.md doc.
19+
- [ ] I have added necessary documentation (if appropriate).
20+
- [ ] Any dependent changes have been merged and published in downstream modules.
21+
22+
## Further comments
23+
24+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

‎CODE_OF_CONDUCT.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
## Code of Conduct
2+
3+
### Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
### Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
### Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
### Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
### Enforcement
56+
57+
Instances of abusive, harassing, or otherwise, unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.

0 commit comments

Comments
 (0)