Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (62 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

107 lines (62 loc) · 2.78 KB

CONTRIBUTING.md

# Contributing to CSE Student Starter Guide

Thank you for your interest in contributing to the CSE Student Starter Guide! 🎉  
This repository aims to provide a comprehensive, beginner-friendly resource for Computer Science students to explore core concepts, tools, and career essentials.

We welcome contributions of all kinds — whether it's improving documentation, adding new resources, or suggesting enhancements. Your input helps make this guide more valuable for everyone.

---

## 🚀 How to Contribute

### 1. Fork the Repository

Start by forking the repository to your GitHub account.

### 2. Clone Your Fork

Clone your fork to your local machine:

```bash
git clone https://github.com/YOUR_USERNAME/cse-student-starter-guide.git
cd cse-student-starter-guide

3. Create a New Branch

Create a new branch for your changes:

git checkout -b feature/your-feature-name

4. Make Your Changes

Make your changes locally. If you're adding new resources or topics, please ensure they align with the existing structure and formatting.

5. Preview Changes Locally

To preview your changes locally, you can use MkDocs:

mkdocs serve

This will start a local server at http://127.0.0.1:8000/ where you can view your changes.

6. Commit Your Changes

Commit your changes with a clear and concise message:

git add .
git commit -m "Add new resource on [Topic]"

7. Push to Your Fork

Push your changes to your fork:

git push origin feature/your-feature-name

8. Open a Pull Request

Open a pull request (PR) to the main branch of the original repository. In your PR description:

  • Provide a brief summary of your changes.
  • Reference any related issues (e.g., Fixes #1).
  • If applicable, include screenshots or examples.

📚 Guidelines for Contributions

  • Documentation: Ensure clarity and accuracy. Use proper formatting and links.
  • Content: Add resources that are relevant, up-to-date, and beneficial for CSE students.
  • Tone: Maintain a friendly, inclusive, and professional tone throughout.

🧪 Reporting Issues

If you encounter any issues or have suggestions:

  • Check the Issues tab to see if it's already reported.
  • If not, open a new issue with a clear description and steps to reproduce (if applicable).

🤝 Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Let's maintain a welcoming and respectful environment for all contributors.

🙏 Thank You!

Your contributions help build a valuable resource for CSE students worldwide. Thank you for your time and effort in making this guide better!

Happy contributing! 🚀