Skip to content

Latest commit

 

History

History
54 lines (46 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

54 lines (46 loc) · 2.88 KB

🤝 Contribution Guidelines

We welcome contributions to the Tarkshastra Book Notes Repository! To ensure that our repository remains a valuable resource for our debate team, please follow these guidelines when contributing:

📚 Suitable Books for Contribution

Contributions should focus on books that are beneficial for debate and MUN preparation. Examples of suitable books include, but are not limited to:

  • Classical works such as those by Plato and Aristotle
  • Historical texts and biographies
  • Books on political theory and philosophy
  • Key legal cases and constitutional law
  • Important modern texts on international relations, economics, and political science

📝 How to Contribute

  1. Fork the Repository: Create a personal fork of the repository on GitHub.
  2. Clone the Fork: Clone your fork to your local machine. 
    git clone https://github.com/yourusername/tarkshastra-book-notes.git
  3. Create a New Branch: Create a new branch for your contribution. 
    git checkout -b add-new-book-notes
  4. Add Your Notes: Create a new folder named after the book you are adding notes for. Add your notes in this folder. Ensure your notes are clear, concise, and well-organized.
  5. Update the README: Add the new book title and direct access link to the Table of Books section in the README.
  6. Commit Your Changes: Commit your changes with a meaningful commit message. 
    git add .
git commit -m "Added notes for 'Book Title'"
  7. Push to Your Fork: Push your changes to your fork on GitHub. 
    git push origin add-new-book-notes
  8. Create a Pull Request: Go to the original repository on GitHub and create a pull request from your fork. Provide a clear description of your contribution.

🔄 Review Process

  • All contributions will be reviewed by the repository maintainers.
  • We may request changes or provide feedback to ensure the quality and relevance of the notes.
  • Once approved, your contribution will be merged into the main repository.

💡 Contribution Tips

  • Ensure your notes are comprehensive but concise.
  • Use clear headings and subheadings for different sections of the notes.
  • Include summaries, key points, and important quotes.
  • Properly cite any external sources you use.

🚫 Unsuitable Content

  • Contributions should not include content that is irrelevant, inappropriate, or not beneficial for debate and MUN preparation.
  • Avoid adding books that do not contribute to the educational and intellectual goals of our team.

📬 Contact

For any questions or further clarification on contributions, feel free to contact us at tarkshastradypcoe@gmail.com.

Thank you for contributing to the Tarkshastra Book Notes Repository and helping our team grow and excel!