Merge pull request #37 from agicommies/test-updates

Test updates

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing to CommuneAI
+
+Thank you for your interest in contributing to CommuneAI! We welcome contributions from the community to help improve and enhance the project.
+
+## Table of Contents
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [How to Contribute](#how-to-contribute)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Pull Requests](#pull-requests)
+- [Style Guidelines](#style-guidelines)
+- [License](#license)
+
+## Getting Started
+To get started with contributing to CommuneAI, follow these steps:
+1. Fork the repository on GitHub.
+2. Clone your forked repository to your local machine.
+3. Create a new branch for your contribution.
+4. Make your desired changes and additions.
+5. Test your changes to ensure they work as intended.
+6. Commit your changes with a descriptive commit message.
+7. Push your changes to your forked repository.
+8. Open a pull request on the original repository, describing your changes in detail.
+
+## How to Contribute
+
+### Reporting Bugs
+If you encounter a bug while using [Project Name], please create a new issue on the GitHub repository. When reporting a bug, please provide the following information:
+- A clear and descriptive title for the issue.
+- Steps to reproduce the bug.
+- Expected behavior and actual behavior.
+- Any relevant error messages or screenshots.
+
+### Suggesting Enhancements
+If you have an idea for an enhancement or new feature for [Project Name], please create a new issue on the GitHub repository. When suggesting an enhancement, please provide the following information:
+- A clear and descriptive title for the issue.
+- A detailed description of the proposed enhancement.
+- Any relevant examples or use cases.
+
+### Pull Requests
+We welcome pull requests for bug fixes, enhancements, and new features. When submitting a pull request, please ensure that:
+- Your code follows the project's [style guidelines](#style-guidelines).
+- Your changes are well-documented and include relevant comments.
+- Your pull request includes a clear and descriptive title and description.
+- Your pull request is based on the latest version of the main branch.
+
+## Style Guidelines
+Please follow these style guidelines when contributing to CommuneAI:
+- Use meaningful variable and function names.
+- Follow the existing code style and formatting conventions.
+- Write clear and concise comments to explain complex or non-obvious code.
+- Include relevant documentation updates when adding new features or making significant changes.