Skip to content

Commit 0296060

Browse files
ansegura7ansegura7
authored
Merge pull request #75 from argrecsys/dev
Dev
2 parents 8ebcf48 + 43ff321 commit 0296060

File tree

6 files changed

+321
-0
lines changed

6 files changed

+321
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: "\U0001F41BBug report"
2+
description: Create a report to help us improve arg-classifier.
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report! Please write a clear and concise description of what the bug is.
9+
- type: input
10+
id: version
11+
attributes:
12+
label: Version
13+
description: Which version of the arg-classifier is?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: expected-behavior
18+
attributes:
19+
label: Expected behavior
20+
description: Please write a clear and concise description of what you expected to happen.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: environment
25+
attributes:
26+
label: Environment
27+
description: |
28+
Please provide us your environment information. You can view this information by entering the following command:
29+
```shell
30+
systeminfo
31+
```
32+
Note: avoid pasting/sharing personal data.
33+
value: |
34+
- OS: [e.g. Windows 11]
35+
- Python version: [e.g. 3.11.x]
36+
- JDK or JRE: [e.g. 17]
37+
- (Optional) Other libraries and their versions:
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: logs
42+
attributes:
43+
label: Error messages, stack traces, or logs
44+
description: Please copy and paste any relevant error messages, stack traces, or log output.
45+
render: shell
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: steps-to-reproduce
50+
attributes:
51+
label: Steps to reproduce
52+
description: Please provide how we reproduce your reported bugs. If possible, it is highly recommended to provide the reproducible example codes.
53+
value: |
54+
1. Go to '...'
55+
2. Click on '....'
56+
3. Scroll down to '....'
57+
4. See error
58+
```java
59+
// Java code
60+
```
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: additional-context
65+
attributes:
66+
label: Additional context (optional)
67+
description: Please add any other context or screenshots if you have.
68+
validations:
69+
required: false

‎.github/ISSUE_TEMPLATE/code-fix.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "\U0001F6A7Code fix"
2+
description: Suggest a code fix that does not change the behaviors of arg-classifier, such as code refactoring.
3+
labels: ["code-fix"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to raise a new issue! Please write a clear and concise description of the code fix.
9+
- type: input
10+
id: version
11+
attributes:
12+
label: Version
13+
description: Which version of the arg-classifier is?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: motivation
18+
attributes:
19+
label: Motivation
20+
description: |
21+
Please write the motivation for the proposal.
22+
If your code fix is related to a problem, please describe a clear and concise description of what the problem is.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: suggestion
27+
attributes:
28+
label: Suggestion
29+
description: Please explain your suggestion for the code change.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: additional-context
34+
attributes:
35+
label: Additional context (optional)
36+
description: Please add any other context or screenshots if you have.
37+
validations:
38+
required: false

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: "\U00002753Questions"
5+
url: "https://github.com/argrecsys/arg-classifier/discussions"
6+
about: "Use the GitHub Discussions to ask support questions."

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: "\U0001F4A1Feature request"
2+
description: Suggest an idea to improve arg-classifier.
3+
labels: ["feature"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time for your feature requests! Please write a clear and concise description of the feature proposal.
9+
- type: input
10+
id: version
11+
attributes:
12+
label: Version
13+
description: Which version of the arg-classifier is?
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: motivation
18+
attributes:
19+
label: Motivation
20+
description: |
21+
Please write the motivation for the proposal.
22+
If your feature request is related to a problem, please describe a clear and concise description of what the problem is.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description
29+
description: Please write a detailed description of the new feature.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: alternatives
34+
attributes:
35+
label: Alternatives (optional)
36+
description: Please write a clear and concise description of any alternative solutions or features you've considered.
37+
validations:
38+
required: false
39+
- type: textarea
40+
id: additional-context
41+
attributes:
42+
label: Additional context (optional)
43+
description: Please add any other context or screenshots if you have.
44+
validations:
45+
required: false

‎docs/CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement.
63+
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎docs/CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing
2+
Welcome, and thank you for your interest in helping to improve and accelerate/ease the adoption of arg-classifier (Argumentative Proposition Classifier).
3+
4+
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved, and hopefully not feel intimidated.
5+
6+
## Asking Questions and Providing Feedback
7+
Have a question? Rather than emailing the author, open an issue.
8+
9+
The community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.
10+
11+
## Reporting Issues and Ideas
12+
Have you identified an oversight or problem? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible.
13+
14+
> **Note:** If you already know what you want to change, feel free to just fork/clone the repo, change it, and submit a pull request. No need to add overhead by creating an issue!
15+
16+
### Look For an Existing Issue
17+
Before you create a new issue, please do a search in [open issues](https://github.com/argrecsys/arg-classifier/issues) to see if the issue or feature request has already been filed.
18+
19+
If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
20+
21+
### Writing Good Bug Reports and Feature Requests
22+
File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
23+
24+
Below is some information you can provide. The more you can provide, the more likely someone will be successful at understanding and incorporating it. However be mindful of the cost/benefit for documenting vs simply implementing the change.
25+
26+
Please include the following with each issue:
27+
- **Title** - Concise and clear to quickly identify the topic.
28+
- **Problem** - Summary of the issue/idea/feature.
29+
- **Possible Solution** - If a solution seems clear, share it as an option.
30+
- **Examples** - "What was expected" vs "What actually ocurred".
31+
- **Context** - External factors that restrict possible solutions. (stuff that can't be changed)
32+
> Example: Please upgrade the vehicle from 30mph to 60mph. Context: budget is $5000.
33+
34+
# Thank You!
35+
Your contributions to arg-classifier, large or small, make great projects like this possible. Thank you for taking the time to contribute!

0 commit comments

Comments
 (0)