Skip to content

Commit a82c9eb

Browse files
Janell-HuyckJanell-Huyck
authored
Version 1 (#9)
* docs: Fix README list of allowed commit types (#5) * feat: Initial setup to extract name, update titles, update PR body (#6) * feat: Update package.json to run Unknown command: "release" (#7) * docs: Move troubleshooting into README (#8)
1 parent 228aba4 commit a82c9eb

File tree

15 files changed

+35139
-10138
lines changed

15 files changed

+35139
-10138
lines changed

__tests__/index.test.js renamed to .gitignore

File renamed without changes.

‎CODE_OF_CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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, caste, color, religion, or sexual
10+
identity 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 overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
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 address,
35+
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 email 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 at
63+
[INSERT CONTACT METHOD].
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 of
86+
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 permanent
93+
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 the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
## Contributing
2+
We welcome contributions to improve the Jira PR Updater GitHub Action. To contribute:
3+
4+
### Development Setup
5+
1. ### Clone the Repository
6+
```bash
7+
git clone https://github.com/your-github-username/update-pr-with-jira.git
8+
cd update-pr-with-jira
9+
```
10+
11+
2. ### Install Dependencies
12+
13+
```bash
14+
npm install
15+
```
16+
3. ### Run Tests
17+
18+
```bash
19+
npm test
20+
```
21+
22+
4. ### Build the Action
23+
24+
```bash
25+
npm run build
26+
```
27+
28+
29+
- Fork the Repository: Create a personal fork of the action repository.
30+
31+
- Create a Feature Branch:
32+
```aiignore
33+
git checkout -b feature/your-feature
34+
```
35+
- Implement Your Changes.
36+
37+
- Commit and Push:
38+
```aiignore
39+
git commit -m "Add your feature"
40+
git push origin feature/your-feature
41+
```
42+
- Open a Pull Request: Submit a pull request to the main repository with a detailed description of your changes.
43+
44+
## Commit Message Guidelines
45+
Our project uses Husky and Commitlint to enforce standardized commit messages based on the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/). Following this format helps make our commit history more readable and makes it easier to generate release notes, automate versioning, and track changes effectively.
46+
47+
### Commit Message Structure
48+
Each commit message should follow this structure:
49+
```
50+
<type>: <subject>
51+
```
52+
`type`: Specifies the nature of the commit. It should be lowercase and describe the type of change you are making.
53+
`subject`: A brief, descriptive summary of the change. It should be written in sentence case (only the first word capitalized) and kept under 50 characters if possible.
54+
55+
### Allowed Commit Types
56+
Here are the main type options we use, along with examples for each:
57+
58+
- `feat`: A new feature for the user.
59+
Example: feat: add user authentication
60+
- `fix`: A bug fix for the user.
61+
Example: fix: resolve login redirect issue
62+
- `docs`: Documentation changes only.
63+
Example: docs: update README with setup instructions
64+
- `style`: Code style changes (formatting, indentation, etc.) without affecting functionality.
65+
Example: style: reformat code to meet style guidelines
66+
- `refactor`: Code changes that improve structure or readability without fixing a bug or adding a feature.
67+
Example: refactor: simplify authentication logic
68+
- `test`: Adding or modifying tests.
69+
Example: test: add unit tests for login component
70+
- `chore`: Routine tasks, such as dependency updates or build process changes.
71+
Example: chore: update dependencies
72+
73+
### Examples of Valid Commit Messages
74+
- `feat: add logout functionality`
75+
- `fix: correct typo in welcome message`
76+
- `docs: add setup instructions to README`
77+
- `style: apply consistent code formatting`
78+
- `refactor: optimize database query logic`
79+
- `test: add tests for profile page`
80+
81+
### Guidelines for Writing Commit Messages
82+
- Keep it short and specific: Use concise descriptions that convey the change.
83+
- Use the imperative mood: For example, use “add feature” instead of “added feature” or “adds feature.”
84+
- Avoid detailed explanations: Focus on the change summary. If further details are needed, include them in the pull request description.
85+
### What Happens If a Commit Message Doesn’t Follow These Rules?
86+
We use Husky to enforce these standards with a Git hook that triggers Commitlint. If your commit message doesn’t follow the specified format, Commitlint will reject the commit and display an error message.
87+
88+
By following these guidelines, we ensure that our commit history remains consistent and organized, making it easier for everyone to understand and track changes over time.

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) [2024] [University of Cincinnati]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)