Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (52 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 2.5 KB

Contributing

👋 Welcome to InftyAI community !

Before you get started

Code of Conduct

Please make sure to read and observe our Code of Conduct first.

Getting started

🚀 All kinds of contributions are welcomed !

  • Fix documents & Typos
  • Report & fix bugs
  • New features
  • Issues & discussions
  • ...

Pull Requests

Pull requests are often called simply "PR". Please follows the standard github pull request process. To submit a proposed change, please develop the code and add new test cases.

Code Review

To make it easier for your PR to receive reviews, consider the reviewers will need you to:

  • Follow good coding guidelines.
  • Write good commit messages.
  • Break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue.

How to Add a New Project

Option 1: Using GitHub Issues (Recommended)

The easiest way to add a new project is by creating a Project Request issue:

  1. Go to the Issues tab
  2. Click "New Issue" and select "Project Request"
  3. Fill out the template with your project information
  4. Submit the issue

GitHub Actions workflow will automatically process your request, create a PR, and add the project to the appropriate category.

Option 2: Manual Addition

To add a new project to the landscape, follow these steps:

  1. Prepare the project logo:

    • Create or obtain a logo for the project (PNG or SVG format recommended)
    • Image should be square or have transparent background
    • Place the logo file in the logos/ directory with a descriptive name

  2. Update data.yml:

    • Find the appropriate category and subcategory for your project
    • Add a new entry under the items section with the following format:
    - name: Project Name
  description: A brief description of the project (1-2 sentences)
  homepage_url: https://github.com/org/repo
  logo: project-logo.png
  repo_url: https://github.com/org/repo

  3. Update the main README.md:

    • Add the project to the appropriate category in the main README.md