-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add CODE_OF_CONDUCT and CONTRIBUTING guidelines; update README for cl…
…arity and engagement
- Loading branch information
1 parent
031e3ee
commit cb652fd
Showing
3 changed files
with
167 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our community include: | ||
|
||
- Demonstrating empathy and kindness toward other people | ||
- Being respectful of differing opinions, viewpoints, and experiences | ||
- Giving and gracefully accepting constructive feedback | ||
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience | ||
- Focusing on what is best not just for us as individuals, but for the overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
- The use of sexualized language or imagery, and sexual attention or advances of any kind | ||
- Trolling, insulting or derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others’ private information, such as a physical or email address, without their explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
||
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](/~https://github.com/mozilla/diversity). | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. | ||
|
||
[homepage]: https://www.contributor-covenant.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Contributing to BuildLab | ||
|
||
Thank you for considering contributing to BuildLab! We welcome contributions from the community and are excited to work with you. | ||
|
||
## How to Contribute | ||
|
||
### Reporting Bugs | ||
|
||
If you find a bug, please report it by opening an issue on our [GitHub Issues](/~https://github.com/buildlab-ai/buildlab/issues) page. Include as much detail as possible to help us diagnose and fix the issue quickly. | ||
|
||
### Suggesting Features | ||
|
||
We are always looking for ways to improve BuildLab. If you have a feature request, please open an issue on our [GitHub Issues](/~https://github.com/buildlab-ai/buildlab/issues) page and describe the feature in detail. | ||
|
||
### Submitting Pull Requests | ||
|
||
1. Fork the repository. | ||
2. Create a new branch for your feature or bugfix. | ||
3. Make your changes. | ||
4. Ensure your code follows our coding standards and passes all tests. | ||
5. Commit your changes and push your branch to your fork. | ||
6. Open a pull request on our [GitHub Pull Requests](/~https://github.com/buildlab-ai/buildlab/pulls) page. | ||
|
||
### Code Style | ||
|
||
Please follow the coding style used in the project. This includes indentation, naming conventions, and documentation. | ||
|
||
### Testing | ||
|
||
Ensure that your changes do not break existing tests and add new tests for any new functionality. | ||
|
||
### Documentation | ||
|
||
Update the documentation to reflect your changes. This includes updating the README.md and any other relevant documentation files. | ||
|
||
## Code of Conduct | ||
|
||
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. | ||
|
||
## Getting Help | ||
|
||
If you need help, feel free to reach out by opening an issue or joining our community chat. | ||
|
||
Thank you for contributing to BuildLab! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,57 @@ | ||
# BuildLab | ||
# 🚀 BuildLab | ||
|
||
<h3>A Project That Builds Projects</h3> | ||
|
||
[](https://x.com/buildlab_ai) | ||
|
||
### A project that builds projects | ||
BuildLab is an innovative platform designed to revolutionize how developers build, explore, and collaborate on projects. You just need to query and instruct LLM Agent to build your projects, and in minutes your project is ready, which is editable and runs in the inbuilt browser and terminal. | ||
BuildLab is an innovative platform designed to revolutionize how developers build, explore, and collaborate on projects. Just query and instruct the LLM Agent, and within minutes, your project is ready—fully editable and running in the inbuilt browser and terminal. 🛠️💡 | ||
|
||
## Features | ||
## ✨ Features | ||
|
||
### 1. **AI-Powered Search** | ||
### 🔍 1. **AI-Powered Search** | ||
- Perform searches with the help of advanced LLMs and web scraping using Google Search. | ||
- Get precise, context-aware answers to your queries. | ||
- Get precise, context-aware answers to your queries. 🔥 | ||
|
||
### ⚛️ 2. **Generate React Projects with LLM Agent** | ||
- Effortlessly build React projects using the built-in code editor and in-app browser. | ||
- Projects are generated by the LLM Agent, making development faster and easier. ⚡ | ||
|
||
### 🧠 3. **Memory-Enhanced Interactions** | ||
- Supports follow-up questions with context awareness, enhancing user-AI interactions. 🤖 | ||
|
||
### 🔒 4. **Create Space** | ||
- A private workspace for developers to create projects securely. 🔑 | ||
- Collaborate by adding other developers to your space. 🤝 | ||
|
||
### 💬 5. **Integrated AI and Group Chat** | ||
- Use `@ai` to interact with the AI for assistance and instructions. 🤖💡 | ||
- Group chat functionality for seamless communication with team members and AI. 📢 | ||
|
||
### 🌎 6. **Explore Section** | ||
- Stay updated with the latest technology trends and news. 📡 | ||
- Curated feeds tailored to developers. 📰 | ||
|
||
## 🔜 Upcoming Features | ||
|
||
- [ ] 🔍 RAG + Vector Search for Teammate Suggestions | ||
- [ ] 🤖 Choose Your Desired Model from the Models List | ||
|
||
## 🤝 Contribution | ||
|
||
### 2. **Generate React Projects with LLM Agent** | ||
- Build React projects effortlessly using the built-in code editor and in-app browser. | ||
- Projects are generated by LLM Agent, making development faster and easier. | ||
We welcome contributions from the community! To contribute to BuildLab, please follow these steps: | ||
|
||
### 3. **Memory-Enhanced Interactions** | ||
- Supports follow-up questions with context awareness, enhancing user-AI interactions. | ||
1. 🍴 Fork the repository. | ||
2. 🌿 Create a new branch (`git checkout -b feature-branch`). | ||
3. ✍️ Make your changes and commit them (`git commit -m 'Add new feature'`). | ||
4. ⬆️ Push to the branch (`git push origin feature-branch`). | ||
5. 🔃 Open a pull request. | ||
|
||
### 4. **Create Space** | ||
- A private workspace for developers to create projects securely. | ||
- Collaborate by adding other developers to your space. | ||
Please ensure your code adheres to our [coding standards](CODE_OF_CONDUCT.md) and includes appropriate tests. For more details, visit the [contribution guide](CONTRIBUTING.md). | ||
|
||
### 5. **Integrated AI and Group Chat** | ||
- Use `@ai` to interact with the AI for assistance and instructions. | ||
- Group chat functionality for seamless communication with team members and AI. | ||
## 📢 Support | ||
|
||
### 6. **Explore Section** | ||
- Stay updated with the latest technology trends and news. | ||
- Curated feeds tailored to developers. | ||
If you encounter any issues or have questions, feel free to open an issue on our GitHub repository. You can also reach out to us on our [X](https://x.com/buildlab_ai) for support and updates. 🚀 | ||
|
||
## Upcoming Features | ||
## 📜 License | ||
|
||
- [ ] RAG + vector search for teammate suggestion | ||
- [ ] Choose your desired model from the models list | ||
BuildLab is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. 📄 |