Skip to content

Commit 02c65d7

Browse files
authored
Revise contributing steps and community information
Updated the contributing guide to streamline the contribution process and improve clarity.
1 parent 4012b20 commit 02c65d7

1 file changed

Lines changed: 37 additions & 62 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 37 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,39 @@ Want to contribute? Whether you're creating new integrations, improving performa
88

99
---
1010

11-
## 💪🏽 Quick Start Guide
12-
13-
Ready to jump in? Follow this quick setup guide to get started smoothly:
11+
## ✨ Steps to Contribute
12+
13+
**Ready to jump in? Follow this quick setup guide to get started smoothly**
1414

1515
1. **Fork** the repo and clone your fork.
16-
2. Navigate to the project folder:
17-
```bash
18-
cd purecpp
19-
```
20-
21-
3. Make sure you have the following packages installed:
22-
- GCC/G++ 13.1
23-
- CMake 3.22+
24-
- Conan 2
25-
- Rust
26-
- Python 3.8+
2716

28-
4. Install the required dependencies:`:
29-
Depending on your system, you may need:
17+
2. [Environment setup](/README.md#environment-setup-ubuntu--debian-for-c-and-python-development)
3018

31-
```bash
32-
sudo apt update && sudo apt install -y gcc-13 g++-13 cmake conan rustc cargo
33-
```
34-
5. Install development conan dependencies::
19+
3. [How to build](/README.md#how-to-build)
3520

36-
```bash
37-
!pip install conan==2.*
38-
```
21+
**All set! Now... it is time to build something powerful**.
3922

40-
6. Run the tests to ensure everything is working::
23+
1. **Work on your feature or bugfix**, ensuring you have unit tests covering your code.
24+
2. **Commit** your changes, then push them to your fork.
4125
```bash
42-
./tests/run_tests
43-
```
26+
git push origin your-feature-branch
27+
````
28+
3. **Open a pull request** on GitHub.
4429

4530

46-
All set! Now it's time to build something powerful. If you need more details, check out the [Development Guidelines](#-Development-Guidelines).
4731

4832
---
49-
## Community Discord
50-
Join our community [Discord](https://discord.gg/8eF9v78Ndv) to ask questions, get support, and collaborate with fellow contributors and users.
33+
---
5134

35+
## Community Discord [![Join us on Discord ](https://img.shields.io/badge/Join_Us_On_Discord-5865F2?logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/8eF9v78Ndv)
36+
- Ask questions and get support
37+
- Share feedback and suggestions
38+
- Connect with the team and other users
39+
40+
---
41+
---
5242

53-
## ⚡ What Can You Contribute To?
43+
## ⚡ What to Contribute?
5444

5545
There are many ways to contribute to **PureCPP**—whether you're a **C++ expert** or just starting out with **high-performance computing**. Here, we focus on **performance, efficiency, and scalability**. Your contributions are always welcome!
5646
@@ -59,19 +49,22 @@ There are many ways to contribute to **PureCPP**—whether you're a **C++ expert
5949
Help us improve **PureCPP** by contributing to our core modules and making the framework even more optimized.
6050
6151
- **New Integrations** (e.g., support for new compilers, optimized bindings, high-performance libraries)
62-
- **Memory Management**, **Parallelism (Threads and CUDA)**, **Matrix and Tensor Operations**
52+
- **Memory Management** ✔️
53+
- **Parallelism (Threads/OpenMP)** ✔️
54+
- **Parallelism (CUDA)**
55+
- **Matrix and Tensor Operations**
6356
- **Advanced Chunking Techniques** to optimize processing
6457
- **Efficient Metadata Extraction and Management**
6558
6659
## 2. ⚙️ Dataloaders and Smart Storage
6760
6861
- **Optimized Dataloaders** for different file types and databases
69-
- **Efficient indexing and retrieval**
70-
- **Smart loading strategies to optimize search performance**
62+
- **Efficient indexing and retrieval** ✔️
63+
- **Smart loading strategies to optimize search performance** ✔️+-
7164
7265
## 3. 🏎️ Vector Database and LLMs
7366
74-
- Implementation and optimization of **high-performance vector databases**
67+
- Implementation and optimization of **high-performance vector databases** ✔️
7568
- **Integration of LLMs** and embedding models for semantic search
7669
- Support for **quantization, fine-tuning, and CUDA optimizations**
7770
@@ -87,8 +80,6 @@ If you’ve used **PureCPP** in an innovative way, share your examples and contr
8780
8881
Got a different idea? We’re open to tests and new approaches—experiment and submit a PR!
8982
90-
91-
9283
---
9384
9485
## 🚀 **Next Steps: What Are We Planning?**
@@ -110,38 +101,22 @@ We are always evolving! Here are the next steps to make our pipelines even more
110101
💡 **Got an idea?** Your contribution is more than welcome! Join us and help take this project even further. 🚀
111102
112103
---
113-
114-
115-
## ✨ Steps to Contribute
116-
117-
1. **Fork** the repository on GitHub.
118-
2. **Clone** your fork to your local machine.
119-
```bash
120-
git clone https://github.com/pureai-ecosystem/purecpp.git
121-
```
122-
3. **Create a branch** for your work.
123-
```bash
124-
git checkout -b your-feature-branch
125-
```
126-
4. **Set up your environment**
127-
5. **Work on your feature or bugfix**, ensuring you have unit tests covering your code.
128-
6. **Commit** your changes, then push them to your fork.
129-
```bash
130-
git push origin your-feature-branch
131-
```
132-
7. **Open a pull request** on GitHub.
133-
134-
Obrigado!
135-
136104
---
137105
138-
139106
## ⚡ **Acknowledgements: Built with Pure Performance**
140107
141-
Big thanks for being part of **PureCPP**—where every bit counts, and every byte makes a difference! 🚀
108+
Big thanks for being part of **PureCPP**— where every bit counts, and every byte makes a difference! 🚀
142109
143110
Whether you're optimizing loops, fine-tuning embeddings, or pushing parallel processing to the limit, your contributions fuel the engine of **high-performance computing**.
144111

145112
We’re not just writing code—we’re compiling the future. 🔥
146113

147-
Keep coding at full speed! 🏎️💻
114+
Keep coding at full speed! 🏎️💻
115+
116+
---
117+
118+
Thank You! Gracias! 謝謝! 감사해요! ありがとう! Спасибо! Obrigado!
119+
120+
121+
---
122+
---

0 commit comments

Comments
 (0)