Contributing
============

We welcome contributions to this repository! Whether you're adding new papers, fixing 
typos, or improving documentation, your help is appreciated.

How to Contribute
-----------------

Adding New Papers
^^^^^^^^^^^^^^^^^

If you'd like to add a new paper to the collection:

1. Fork the repository
2. Add the paper information to the table in the README.md
3. If the paper introduces a new category or technique, consider adding a section in the documentation
4. Submit a pull request with a clear description of the paper and its contribution

Paper Submission Guidelines
"""""""""""""""""""""""""""

When adding a paper, please include:

* **Title** - Full paper title with link to arXiv, ACL Anthology, or conference proceedings
* **Authors** - Primary authors (use "et al." for papers with many authors)
* **Venue** - Conference/journal and year (e.g., "SIGIR 2021", "Arxiv 2020")
* **Code** - Link to official implementation if available, otherwise mark as "NA"
* **Key Contribution** - One-line summary of the paper's main innovation

Improving Documentation
^^^^^^^^^^^^^^^^^^^^^^^

Documentation improvements are always welcome:

* Fix typos or grammatical errors
* Clarify confusing explanations
* Add examples or use cases
* Improve formatting or structure
* Add diagrams or visualizations

Suggesting New Sections
^^^^^^^^^^^^^^^^^^^^^^^^

If you think a new section would be valuable (e.g., "Re-ranking Methods", 
"Cross-Encoder Techniques", "Evaluation Metrics"), please:

1. Open an issue describing the proposed section
2. List 3-5 papers that would fit in this category
3. Explain why this categorization would be useful

Pull Request Process
--------------------

1. Ensure your changes follow the existing format and style
2. Update the documentation if you're adding significant new content
3. Test that all links work correctly
4. Write a clear PR description explaining your changes
5. Be responsive to feedback and requested changes

Code of Conduct
---------------

* Be respectful and constructive in all interactions
* Focus on the content and ideas, not individuals
* Assume good faith in others' contributions
* Help create a welcoming environment for researchers at all levels

Recognition
-----------

Contributors will be acknowledged in the repository. Significant contributions may 
result in co-authorship credit if the collection is published as a survey or resource paper.

Questions?
----------

If you have questions about contributing, please:

* Open an issue for general questions
* Email the maintainers for private concerns
* Check existing issues to see if your question has been answered

We look forward to your contributions!

GitHub Repository
-----------------

Visit our repository to contribute:

* Repository: https://github.com/pendu/Advanced-Retreival-and-Re-ranking/tree/main/docs/source/

.. note::

   The repository name contains a historical typo ("Retreival" instead of "Retrieval"). 
   This is intentional to maintain URL stability.

License
-------

This repository and its documentation are provided for educational and research purposes.
All papers remain under their original licenses and copyrights.