Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (35 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

44 lines (35 loc) · 1.85 KB

Contribution Guidelines

This repository aims to collect high quality resources. Hence, it is appreciated if you can make clear why these resources are valuable (e.g. by making sure that articles are well sourced, reproducible, have codes...).

Submit to the Awesome AI Reliability` repository

  1. Fork the Repository: Click the "Fork" button in the top-right corner of the repository page.
  2. Clone Your Fork: Clone the fork to your local machine. 
    git clone https://github.com/your-username/awesome-ai-efficiency.git
  3. Create a New Branch: Use descriptive names for your branch. 
    git checkout -b feature/add-resource
  4. Make Your Changes: Edit the files and commit your changes with a clear message. 
    git add .
git commit -m "Add new resource: [Resource Name]"
  5. Push Your Changes: Push your branch to your forked repository. 
    git push origin feature/add-resource
  6. Submit a Pull Request: Open a pull request to the main repository.
    • Clearly describe your changes and the purpose of the pull request.
    • Ensure your PR follows the repository’s style guide.

Style Guide

General Guidelines

  • Use Markdown syntax for all entries.
  • Maintain consistent formatting and spacing.
  • Ensure tags and links are properly formatted.

Tags

Use badges for tags, ensuring they are relevant to the resource. The list of tags are here. You can suggest to extend the list of tags if multiple resources are relevant to this new topic.

Acknowledgments

This repository thrives on contributions from the community. Thank you for taking the time to improve Awesome AI Efficiency. Your input makes this project better for everyone!