Merge pull request #52 from loftwah/dl/code-of-conduct

coc

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+# Pull Request for Linkarooie
+
+## Summary
+
+Provide a brief description of the changes made in this PR. Include the purpose and key points.
+
+## Changes
+
+- **What was added/changed?**
+- **Why is this necessary?**
+
+## Testing
+
+- **How did you test your changes?**
+- **Any specific instructions for testing?**
+
+## Checklist
+
+- [ ] Code follows project guidelines.
+- [ ] Changes have been tested.
+- [ ] Relevant documentation has been updated.
+
+## Additional Notes
+
+Anything else reviewers should know? Mention here.

.github/workflows/deploy.yml

@@ -1,4 +1,4 @@
-name: Deploy
+name: Deploy and Release
 
 on:
   pull_request:
@@ -13,7 +13,7 @@ on:
         default: 'main'
 
 jobs:
-  deploy:
+  deploy_and_release:
     runs-on: ubuntu-latest
     if: |
       github.event_name == 'workflow_dispatch' ||
@@ -66,3 +66,17 @@ jobs:
           
           # Remove unused images and containers
           docker system prune -af
+
+    - name: Get current date
+      id: date
+      run: echo "DATE=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
+
+    - name: Create Release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: release-${{ steps.date.outputs.DATE }}
+        release_name: Release ${{ steps.date.outputs.DATE }}
+        draft: false
+        prerelease: false

CODE_OF_CONDUCT.md

@@ -0,0 +1,53 @@
+# Contributor Code of Conduct
+
+## Introduction
+
+As the creator and maintainer of this project, I am committed to fostering an inclusive and respectful environment for everyone. I value the participation of each contributor and want to ensure that all participants have a positive and enriching experience. This Code of Conduct outlines my expectations for behavior and establishes guidelines for maintaining a welcoming and harassment-free environment.
+
+## My Pledge
+
+In the interest of fostering an open and welcoming environment, I pledge to make participation in this project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Standards of Behavior
+
+Examples of behavior that contribute to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy and kindness towards other community members
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Responsibility
+
+As the project maintainer, I am responsible for clarifying the standards of acceptable behavior and will take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+I reserve the right to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that do not align with this Code of Conduct, or to ban temporarily or permanently any contributor whose behavior is deemed inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Representation of the project may be further defined and clarified by me as the project maintainer.
+
+## Reporting Issues
+
+Instances of abusive, harassing, or otherwise unacceptable behavior can be reported by contacting me directly at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
+
+I am committed to maintaining confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be determined on a case-by-case basis.
+
+## Enforcement
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately. If a contributor engages in unacceptable behavior, I may take any action deemed appropriate, including a temporary or permanent ban from the project without warning.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+
+For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to Linkarooie
+
+Welcome! If you're interested in contributing to Linkarooie, here's a quick guide to get you started.
+
+## How to Contribute
+
+1. **Fork the Repository**: Start by forking the repository to your own GitHub account.
+
+2. **Clone Your Fork**: Clone your fork to your local machine.
+
+   ```bash
+   git clone https://github.com/your-username/linkarooie.git
+   ```
+
+3. **Create a New Branch**: Make changes on a separate branch.
+
+   ```bash
+   git checkout -b your-feature-branch
+   ```
+
+4. **Make Your Changes**: Work on your feature, bug fix, or documentation update. Keep your changes concise and focused.
+
+5. **Test Your Changes**: Ensure that all tests pass and the project builds correctly.
+
+6. **Submit a Pull Request**: Once you're happy with your changes, push them to your fork and submit a pull request to the `main` branch.
+
+## Guidelines
+
+- **Quality**: Code should be clean, well-documented, and follow the project's existing coding style.
+- **Relevance**: Contributions should align with the project's goals and add meaningful improvements or fixes.
+- **Passive Contributions**: Feel free to contribute at your own pace. I may review and merge pull requests if I find them valuable.
+
+## Feedback and Reviews
+
+- Contributions are welcome, but I reserve the right to accept or decline pull requests based on their relevance and quality.
+- I may not actively review all contributions immediately, but if I like what I see, I might merge it.
+
+## Thank You
+
+Your interest in improving Linkarooie is greatly appreciated. Even small contributions can make a big difference!
+
+Happy coding!
+
+Dean Lofts
+[[email protected]]([email protected])

VERSION

@@ -0,0 +1 @@
+1.0.0