Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
227 lines (173 loc) · 7.27 KB

CONTRIBUTION.md

File metadata and controls

227 lines (173 loc) · 7.27 KB

Contributing to Kagent

Thank you for your interest in contributing to Kagent! This document provides guidelines and instructions for contributing to the project.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/YOUR-USERNAME/website.git
cd website
  3. Add the upstream repository: 
    git remote add upstream https://github.com/kagent-dev/website.git
  4. Create a new branch for your feature: 
    git checkout -b feature/your-feature-name
  5. Install dependencies: 
    npm install
# or
yarn install
  6. Start the development server: 
    npm run dev
# or
yarn dev

Pull Request Process

  1. Update your fork with the latest changes from upstream:

    git fetch upstream
git rebase upstream/main

  2. Push your changes to your fork:

    git push origin feature/your-feature-name

  3. Create a Pull Request from your fork to the main repository

  4. Fill out the PR template with all required information

  5. Address review comments if requested by maintainers

  6. Update your PR if needed:

    git add .
git commit -m "address review comments"
git push origin feature/your-feature-name

  7. Once approved, a maintainer will merge your PR

Contributing Blog Posts

The kagent website includes a blog section where we post about kagent. If you'd like to submit a blog post to kagent.dev, make sure your article meets the guidelines below. If you have any questions or you'd like to discuss your ideas, please send us a meessage on our Discord server.

Blog post guidelines

  • Posts should be about the kagent project and valuable to our community
  • Posts should focus on the open source kagent project and not vendor specific projects or products
  • Any submitted blog posts must be original content and not a copy of existing blog posts

Writing a new blog post on kagent

  1. Create your blog post in src/blogContent folder. You can copy an existing blog post and modify it.
  2. Make sure you add the following metadata at the top of your blog post - update the title, published date, description, author, and authorIds accordingly.
export const metadata = {
  title: "AI Reliability Engineering For More Dependable Humans",
  publishDate: "2025-05-14T10:00:00Z",
  description: "AI Reliability Engineering (AIRE) brings AI agents to SRE and Platform Engineering workflows for dependable humans.",
  author: "Christian Posta",
  authorIds: ["christianposta"],
}
  1. Next, you must add the blog post to the main blog page. You can do that by adding a new entry into the post array in this file https://github.com/kagent-dev/website/blob/main/src/app/blog/page.tsx. For example:
const posts = [
    {
        slug: 'ai-reliability-aire',
        publishDate: '2025-05-14',
        title: 'AI Reliability Engineering For More Dependable Humans',
        description: 'AI Reliability Engineering (AIRE) brings AI agents to SRE and Platform Engineering workflows for dependable humans.',
    },
    ...
    {
        slug: 'your-blog-post-slug',
        publishDate: '2025-05-14',
        title: 'Your title',
        description: 'Your description',
    }
]

Make sure the slug in this file matches the slug you used in the .mdx file.

If you need to add a new author, you can do that in the authors.ts file. Make sure the id of an author matches the author ID you used in the metadata in your blog post.

  1. All images can be added to the public/images folder.

Adding an existing blog post

To add an existing blog post, you can add a new entry into the external-blog-posts.yaml file. Same guidelines as above apply.

Style Guide

  • Follow the existing code style
  • Use meaningful variable and function names
  • Write clear comments for complex logic
  • Keep functions small and focused
  • Use TypeScript for type safety
  • Follow ESLint and Prettier configurations

Documentation

  • Update documentation for any changes to APIs, CLIs, or user-facing features
  • Add examples for new features
  • Update the README if necessary
  • Add comments to your code explaining complex logic
  • Keep documentation in sync with code changes

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting PR
  • Include edge cases in tests
  • Maintain or improve test coverage

Commit Messages

We follow the Conventional Commits specification:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • chore: Changes to the build process or auxiliary tools

Example commit message:

feat(controller): add support for custom resource validation

This adds validation for the KagentApp custom resource to ensure
that the configuration is valid before applying it to the cluster.

Closes #123

Signing Your Commits

All commits must be signed with a Developer Certificate of Origin (DCO). This is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.

How to Sign Your Commits

  1. Configure Git to sign your commits:

    git config --global user.signingkey YOUR_GPG_KEY_ID

  2. Sign your commits when making them:

    git commit -s -m "your commit message"

    The -s flag adds a Signed-off-by line to your commit message.

  3. For existing commits that need to be signed, you can amend them:

    git commit --amend -s --no-edit

  4. When pushing changes, make sure to push the signed commits:

    git push --force-with-lease origin your-branch-name

DCO Sign-off Format

Each commit message must include a sign-off line in the following format:

Signed-off-by: Your Name <your.email@example.com>

This line certifies that you have the right to submit the work under the project's license and agree to the Developer Certificate of Origin.

Community

  • Join our Discord server for discussions
  • Participate in community calls (scheduled on our website)
  • Help answer questions in GitHub issues
  • Review pull requests from other contributors

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.

Questions and Help

If you have any questions about contributing, please open an issue or reach out to the maintainers.