Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 3.63 KB

contributing.md

File metadata and controls

41 lines (27 loc) · 3.63 KB

Contribution Guidelines

Welcome to the AI Hackerspace Consulting Collective (AiHCC)! We're thrilled to have you join our community of AI professionals dedicated to collaborative innovation. Below, you'll find detailed instructions on how to contribute to our collective efforts through GitHub. Whether you're looking to participate in projects, propose new initiatives, or join one of our working groups, here's how you can get started and make your mark.

Getting Started

  1. Join the Collective: Begin by signing up through the member portal on our website. This will give you access to our resources and the community.
  2. Read the Contributing Guidelines: Before you dive in, take a moment to familiarize yourself with our workflow and standards by reading the CONTRIBUTING.md file. This document contains essential information that will help you contribute effectively.

How to Contribute

Participate in Projects

  1. Find a Project: Browse our GitHub repository to find ongoing projects that match your skills and interests. Each project is located within its respective directory, such as implementation or technical_expertise.
  2. Express Interest: Once you've identified a project you'd like to contribute to, express your interest by commenting on the project's issue or discussion thread.
  3. Get Assigned: The project lead will review your interest and, if it's a good fit, assign you to the project.

Propose New Initiatives

  1. Draft Your Proposal: If you have an idea for a new project or an improvement to existing processes, start by drafting a proposal. Your proposal should outline the objectives, benefits, and a rough plan for implementation.
  2. Submit Your Proposal: Create a new issue in the docs directory with your proposal. Use the title format Proposal: [Your Proposal Title] for clarity.
  3. Community Feedback: The community will review your proposal. Engage with any feedback to refine and improve your idea.

Join Working Groups

  1. Select a Working Group: Identify which working group(s) you're interested in joining, such as marketing, technical, or project_management. Each group has its own directory and README.md with specific information.
  2. Express Interest: To join, comment on the most recent discussion thread in the working group's directory expressing your interest and how you can contribute.
  3. Participation: Once accepted, you'll be added to the working group by the group's coordinator. Participate in meetings, discussions, and projects as part of the group.

Contributing via GitHub Pull Requests

For all contributions, including documentation, code, or project proposals, we use GitHub Pull Requests (PRs). Here's how to submit a PR:

  1. Fork the Repository: Start by forking the AiHCC repository to your GitHub account.
  2. Create a New Branch: In your fork, create a new branch for your contribution. Name it appropriately based on the content of your contribution.
  3. Make Your Changes: Add your contribution to your branch. This could be adding documentation, code, or project files.
  4. Submit a Pull Request: Once you're ready, submit a PR from your branch to the AiHCC repository. Ensure your PR has a clear title and description explaining your contribution.
  5. Review Process: The community will review your PR. Be open to feedback and ready to make adjustments as needed.
  6. Merge: Once your PR is approved, a repository maintainer will merge it into the main branch.

Thank you for contributing to AiHCC! Your efforts help us drive forward the mission of democratizing AI consulting services and fostering a collaborative, innovative community.