Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (29 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

34 lines (29 loc) · 1.61 KB

Contributing to Code-Library

First off, thank you for considering contributing to the Code-Library! It's people like you that make this a great knowledge base for everyone.

How to Contribute

  1. Fork the Repository: Start by forking this repository to your own GitHub account.
  2. Clone the Repository: Clone your fork to your local machine. 
    git clone https://github.com/YourUsername/Code-Library.git
  3. Create a Branch: Always create a new branch for your topic or fix. 
    git checkout -b new-topic/my-awesome-addition
  4. Follow the Structure:
    • Each major topic should have its own directory.
    • Inside the directory, the primary document should be named matching the folder name with underscores instead of spaces. E.g., My Topic/My_Topic.md
    • Use standard Markdown formatting. Do not dump massive blocks of text into the root README.md.
    • Instead, add a link in the README.md pointing to your new dedicated folder.
  5. Commit and Push: 
    git commit -m "Add documentation for My Awesome Addition"
git push origin new-topic/my-awesome-addition
  6. Submit a Pull Request: Go to the original repository and open a Pull Request. Provide a clear description of what you've added or fixed!

What are we looking for?

  • Code snippets and logic examples.
  • Explanations of core computer science subfields.
  • Clean formatting and easily digestible insights.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.