Skip to content

Commit

Permalink
updating contributing and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daveshap committed Nov 9, 2023
1 parent 19afe95 commit 93ae65b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Project: Hierarchical Autonomous Agent Swarm
# Hierarchical Autonomous Agent Swarm (HAAS)

## Overview

Expand Down
24 changes: 19 additions & 5 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
# Contributing
# Contributing to Hierarchical Autonomous Agent Swarm (HAAS)

1. Start with Discussions: Talk about what you're doing, ask questions.
2. Then move to Issues: Once an issue has been discussed, create a formal issue.
3. Finally create a PR: Once an issue has been clarified, submit a PR.
Thank you for your interest in contributing to the Hierarchical Autonomous Agent Swarm (HAAS) project. This document outlines the process for contributing in a way that is efficient and aligns with the project's goals.

Unsolicited and undiscussed PRs will likely be rejected
## Contribution Workflow

1. **Watch the Latest YouTube Video**: Stay updated with the project's progress and priorities by watching the latest video updates from Dave, the project owner.

2. **Discuss on the Discussions Tab**: Engage with the community by discussing ideas, suggestions, and feedback related to the latest updates on the GitHub Discussions tab.

3. **Create an Issue**: If you identify a bug or have a feature request, create an issue on GitHub detailing your findings or suggestions.

4. **Submit a PR**: Once you've discussed your idea and created an issue, you can fork the repository, make your changes, and submit a pull request (PR) for review.

## Ground Rules for Commenting and Contributing

1. **Stay on Topic**: Discussions should be relevant to the project's current scope and topics presented in the latest YouTube update. Off-topic discussions, meta commentary, or attempts to change the project's scope will be removed. Repeated violations may lead to a ban.

2. **Adhere to the C3P0 Policy**: We follow the Collaborative Culture Community Policy: Zero Tolerance (C3P0) for harmful behavior and time-wasting. [C3P0 Policy](https://github.com/daveshap/C3P0).

3. **PR Requirements**: All PRs must include a clear description. Limit submissions to one PR per day, ensuring it adheres to the project's style and structure. Refraining from reformatting, refactoring, or restructuring the project is crucial—non-compliant PRs will be rejected.

0 comments on commit 93ae65b

Please sign in to comment.