Fix broken links, add CI/CD for automated link checking, update markdown files to latest standards for dev/community (#145)

Fixes: #139

Author: markurtz

.github/workflows/development.yml

@@ -37,11 +37,27 @@ jobs:
       - name: Run quality checks
         run: tox -e types
 
+  link-checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.9"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install dependencies
+        run: pip install tox
+      - name: Run link checks
+        run: tox -e links
+
   precommit-checks:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ["3.9", "3.13"]
+        python: ["3.9"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python

.github/workflows/main.yml

@@ -38,11 +38,27 @@ jobs:
       - name: Run quality checks
         run: tox -e types
 
+  link-checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.9"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install dependencies
+        run: pip install tox
+      - name: Run link checks
+        run: tox -e links
+
   precommit-checks:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python: ["3.9"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python

.github/workflows/nightly.yml

@@ -5,6 +5,22 @@ on:
     - cron: '0 0 * * *'  # Runs at midnight every night
 
 jobs:
+  link-checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.9"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install dependencies
+        run: pip install tox
+      - name: Run link checks
+        run: tox -e links
+
   unit-tests:
     runs-on: ubuntu-latest
     strategy:

.github/workflows/release-candidate.yml

@@ -6,6 +6,22 @@ on:
       - 'release/*'
 
 jobs:
+  link-checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.9"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install dependencies
+        run: pip install tox
+      - name: Run link checks
+        run: tox -e links
+
   unit-tests:
     runs-on: ubuntu-latest
     strategy:

.github/workflows/release.yml

@@ -51,6 +51,22 @@ jobs:
           password: ${{ secrets.PYPI_PUBLIC_AUTH }}
           whl: $(find dist -name '*.tar.gz')
 
+  link-checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.9"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install dependencies
+        run: pip install tox
+      - name: Run link checks
+        run: tox -e links
+
   unit-tests:
     runs-on: ubuntu-latest
     strategy:

CODE_OF_CONDUCT.md

@@ -1,47 +1,77 @@
-# Community Code of Conduct
+# GuideLLM Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and 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, religion, or sexual identity and orientation.
+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, 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 creating a positive environment include:
+Examples of behavior that contributes to a positive environment for our community 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 towards other community members
+- 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 by participants include:
+Examples of unacceptable behavior include:
 
-- The use of sexualized language or imagery and unwelcome sexual attention or advances
-- Trolling, insulting/derogatory comments, and personal or political attacks
+- 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 electronic address, without explicit permission
+- 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
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+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.
 
-Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors 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 project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+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 e-mail 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 by contacting the project team using the [Neural Magic Contact Us Form](https://neuralmagic.com/contact). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement through GitHub, Slack, or Email. 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.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+**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 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+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.
 
-For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
+Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
-[homepage]: https://www.contributor-covenant.org
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -1,68 +1,121 @@
 # Contributing to GuideLLM
 
-If you’re reading this, hopefully we have piqued your interest to take the next step. Join us and help make GuideLLM even better! As a contributor, here are some community guidelines we would like you to follow:
+Thank you for considering contributing to GuideLLM! We welcome contributions from the community to help improve and grow this project. This document outlines the process and guidelines for contributing.
 
-- [Code of Conduct](#code-of-conduct)
-- [Ways to Contribute](#ways-to-contribute)
-- [Bugs and Feature Requests](#bugs-and-feature-requests)
-- [Question or Problem](#question-or-problem)
-- [Developing GuideLLM](DEVELOPING.md)
+## How Can You Contribute?
 
-## Code of Conduct
+There are many ways to contribute to GuideLLM:
 
-Help us keep the software inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) in order to promote an environment that is friendly, fair, respectful, and safe. We want to inspire collaboration, innovation, and fun!
+- **Reporting Bugs**: If you encounter a bug, please let us know by creating an issue.
+- **Suggesting Features**: Have an idea for a new feature? Open an issue to discuss it.
+- **Improving Documentation**: Help us improve our documentation by submitting pull requests.
+- **Writing Code**: Contribute code to fix bugs, add features, or improve performance.
+- **Reviewing Pull Requests**: Provide feedback on open pull requests to help maintain code quality.
 
-## Ways to Contribute
+## Getting Started
 
-Whether you’re a newbie, dabbler, or expert, we appreciate you jumping in.
+### Prerequisites
 
-### Contributing Code
+Before contributing, ensure you have the following installed:
 
-- Make pull requests for addressing bugs, open issues, and documentation
-- Neural Magic as the maintainer will do reviews and final merge
+- Python 3.9 or higher
+- pip (Python package manager)
+- Tox
+- Git
 
-### Reporting In
+### Setting Up the Repository
 
-- See something, say something: bugs, documentation
-- Propose new feature requests to Neural Magic
+You can either clone the repository directly or fork it if you plan to contribute changes back:
 
-### Helping Others
+#### Option 1: Cloning the Repository
 
-- Answer open discussion topics
-- Spread the word about GuideLLM
-- Teach and empower others. This is the way!
+1. Clone the repository to your local machine:
 
-## Bugs and Feature Requests
+   ```bash
+   git clone https://github.com/neuralmagic/guidellm.git
+   cd guidellm
+   ```
 
-Please search through existing issues and requests first to avoid duplicates. Neural Magic will work with you further to take next steps.
+#### Option 2: Forking the Repository
 
-- Go to: [GitHub Issues](https://github.com/neuralmagic/guidellm/issues)
+1. Fork the repository by clicking the "Fork" button on the repository's GitHub page.
 
-For bugs, include:
+2. Clone your forked repository to your local machine:
 
-- brief summary
-- OS/Environment details
-- steps to reproduce (s.t.r.)
-- code snippets, screenshots/casts, log content, sample models
-- add the GitHub label "bug" to your post
+   ```bash
+   git clone https://github.com/<your-username>/guidellm.git
+   cd guidellm
+   ```
 
-For feature requests, include:
+For detailed instructions on setting up your development environment, please refer to the [DEVELOPING.md](https://github.com/neuralmagic/speculators/blob/main/DEVELOPING.md) file. It includes step-by-step guidance on:
 
-- problem you’re trying to solve
-- community benefits
-- other relevant details to support your proposal
-- add the GitHub label "enhancement" to your post
+- Installing dependencies
+- Running tests
+- Using Tox for various tasks
 
-For documentation edits, include:
+## Code Style and Guidelines
 
-- current state, proposed state
-- if applicable, screenshots/casts
-- add the GitHub label "documentation" to your post
+We follow strict coding standards to ensure code quality and maintainability. Please adhere to the following guidelines:
 
-## Question or Problem
+- **Code Style**: Use [Black](https://black.readthedocs.io/en/stable/) for code formatting and [Ruff](https://github.com/charliermarsh/ruff) for linting.
+- **Type Checking**: Use [Mypy](http://mypy-lang.org/) for type checking.
+- **Testing**: Write unit tests for new features and bug fixes. Use [pytest](https://docs.pytest.org/) for testing.
+- **Documentation**: Update documentation for any changes to the codebase.
 
-Sign up or log in to our [**Neural Magic Community Slack**](https://neuralmagic.com/community/). We are growing the community member by member and happy to see you there. Don’t forget to search through existing discussions to avoid duplication! Thanks!
+To check code quality locally, use the following Tox environment:
 
-## Developing GuideLLM
+```bash
+tox -e quality
+```
 
-Made it this far? Review [Developing GuideLLM](DEVELOPING.md) to get started.
+To automatically fix style issues, use:
+
+```bash
+tox -e style
+```
+
+To run type checks, use:
+
+```bash
+tox -e types
+```
+
+## Submitting Changes
+
+1. **Create a Branch**: Create a new branch for your changes:
+
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make Changes**: Commit your changes with clear and descriptive commit messages.
+
+3. **Run Tests and Quality Checks**: Before submitting your changes, ensure all tests pass and code quality checks are satisfied:
+
+   ```bash
+   tox
+   ```
+
+4. **Push Changes**: Push your branch to your forked repository (if you forked):
+
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+5. **Open a Pull Request**: Go to the original repository and open a pull request. Provide a clear description of your changes and link any related issues.
+
+## Reporting Issues
+
+If you encounter a bug or have a feature request, please open an issue on GitHub. Include as much detail as possible, such as:
+
+- Steps to reproduce the issue
+- Expected and actual behavior
+- Environment details (OS, Python version, etc.)
+
+## Community Standards
+
+We are committed to fostering a welcoming and inclusive community. Please read and adhere to our [Code of Conduct](https://github.com/neuralmagic/speculators/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+By contributing to Speculators, you agree that your contributions will be licensed under the [Apache License 2.0](https://github.com/neuralmagic/speculators/blob/main/LICENSE).