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)

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+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.
+
+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.
+
+## Scope
+
+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 email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,88 @@
+## Contributing
+We welcome contributions to improve the Jira PR Updater GitHub Action. To contribute:
+
+### Development Setup
+1. ### Clone the Repository
+```bash
+git clone https://github.com/your-github-username/update-pr-with-jira.git
+cd update-pr-with-jira
+```
+
+2. ### Install Dependencies
+
+```bash
+npm install
+```
+3. ### Run Tests
+
+```bash
+npm test
+```
+
+4. ### Build the Action
+
+```bash
+npm run build
+```
+
+
+- Fork the Repository: Create a personal fork of the action repository.
+
+- Create a Feature Branch:
+```aiignore
+git checkout -b feature/your-feature
+```
+- Implement Your Changes.
+
+- Commit and Push:
+```aiignore
+git commit -m "Add your feature"
+git push origin feature/your-feature
+```
+- Open a Pull Request: Submit a pull request to the main repository with a detailed description of your changes.
+
+## Commit Message Guidelines
+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.
+
+### Commit Message Structure
+Each commit message should follow this structure:
+```
+<type>: <subject>
+```
+`type`: Specifies the nature of the commit. It should be lowercase and describe the type of change you are making.
+`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.
+
+### Allowed Commit Types
+Here are the main type options we use, along with examples for each:
+
+- `feat`: A new feature for the user.
+  Example: feat: add user authentication
+- `fix`: A bug fix for the user.
+  Example: fix: resolve login redirect issue
+- `docs`: Documentation changes only.
+  Example: docs: update README with setup instructions
+- `style`: Code style changes (formatting, indentation, etc.) without affecting functionality.
+  Example: style: reformat code to meet style guidelines
+- `refactor`: Code changes that improve structure or readability without fixing a bug or adding a feature.
+  Example: refactor: simplify authentication logic
+- `test`: Adding or modifying tests.
+  Example: test: add unit tests for login component
+- `chore`: Routine tasks, such as dependency updates or build process changes.
+  Example: chore: update dependencies
+
+### Examples of Valid Commit Messages
+- `feat: add logout functionality`
+- `fix: correct typo in welcome message`
+- `docs: add setup instructions to README`
+- `style: apply consistent code formatting`
+- `refactor: optimize database query logic`
+- `test: add tests for profile page`
+
+### Guidelines for Writing Commit Messages
+- Keep it short and specific: Use concise descriptions that convey the change.
+- Use the imperative mood: For example, use “add feature” instead of “added feature” or “adds feature.”
+- Avoid detailed explanations: Focus on the change summary. If further details are needed, include them in the pull request description.
+### What Happens If a Commit Message Doesn’t Follow These Rules?
+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.
+
+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

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