chore: add contribution guidelines (#3)

* chore: add CONTRIBUTING.md

* chore: add missing resources field
This commit is contained in:
Emanuel Ferreira
2024-02-24 16:01:45 -03:00
committed by GitHub
parent 8721ca576f
commit d1165bbba8
5 changed files with 32 additions and 5 deletions
+21
View File
@@ -0,0 +1,21 @@
# Contributing to Awesome RAG
Awesome-rag is a curated list of awesome resources for RAG (Retrieval Augmentation Generation) exploration. It is a community-driven project, and we welcome your contributions! Whether you want to add a new paper, blogpost, or resource, or you want to improve the existing content, your help is welcome!
Our goal is to create a comprehensive list of resources that can be used for anyone interested in RAG exploration. We want to make it easy for people to find the best resources and to stay up-to-date with the latest developments in the field.
Also, we want to ensure that not only the most relevant papers are included, but also the most relevant insights, results, and resources are provided for each paper.
## How to contribute
1. Fork the repository
2. Clone your forked repository to your local machine
3. Create a new branch
4. Make your changes
5. Push your changes to your forked repository and submit a pull request
## Adding a new paper
1. Create a new markdown file in the `papers` directory
2. Follow the [template](./PAPER_TEMPLATE.MD) to add the paper details
3. Add the paper to the `README.md` file under the `Papers` section following the existing format
+1 -2
View File
@@ -6,5 +6,4 @@
## Insights
## Resources
+4 -1
View File
@@ -32,4 +32,7 @@
- [SELF-RAG: LEARNING TO RETRIEVE, GENERATE, AND CRITIQUE THROUGH SELF-REFLECTION](./papers/self-rag.md) - A retrieval-augmented generation model that can be used for self-reflection. (Akari, et al. 2023)
- [Chain-of-Table: Evolving Tables in the Reasoning Chain for Table Understanding](./papers/chain-of-table.md) - A retrieval-augmented generation model that can be used for table understanding. (Zilong, et al. 2024)
- [Chain-of-Table: Evolving Tables in the Reasoning Chain for Table Understanding](./papers/chain-of-table.md) - A retrieval-augmented generation model that can be used for table understanding. (Zilong, et al. 2024)
## Contributing
Interested in contributing? Please read the [contribution guidelines](CONTRIBUTING.md) first.
+3 -1
View File
@@ -4,4 +4,6 @@
## Results
## Insights
## Insights
## Resources
+3 -1
View File
@@ -4,4 +4,6 @@
## Results
## Insights
## Insights
## Resources