Skip to content

Contributing.md

Latest commit

 

History

History
102 lines (65 loc) · 3.22 KB

Contributing.md

File metadata and controls

102 lines (65 loc) · 3.22 KB

Contributing to Competitive Programming 101

Thank you for considering contributing to Competitive Programming 101! Your contributions are what make this project an incredible resource for the community. This guide will help you get started with contributing.

Contributors

This project is made possible by the efforts of the following individuals:

Creators

  • Wafae Boumajjane: Competitive programming cell Head and Software engineering student.
  • Hamza Bouali: Competitive programming cell Co-Head and Data science student.
  • Salim Elmardi: Data/Ai cell Co-Head and Data science student.

How You Can Contribute

We welcome all types of contributions, including but not limited to:

  • Adding new problems and solutions.
  • Writing tutorials or improving existing documentation.
  • Sharing links to useful resources (blogs, videos, courses).
  • Fixing typos or grammatical errors.
  • Enhancing the repository structure or content.

📋 Contribution Guidelines

1. Fork the Repository

Start by forking the repository to your own GitHub account:

  1. Navigate to the repository: Competitive Programming 101.
  2. Click on the Fork button (top-right corner).

2. Clone the Repository

Clone the forked repository to your local machine:

git clone https://github.com/your-username/competitive-programming-101.git
cd competitive-programming-101

3. Create a New Branch

Create a branch for your changes:

git checkout -b feature/your-feature-name

4. Make Your Changes

  • Add your contributions in the relevant folder.
  • Ensure your code is clean and well-documented.
  • If adding a new problem, include both the problem statement and solution.
  • Test your changes locally.

5. Commit Your Changes

After making your changes, commit them with a clear and concise message:

git add .
git commit -m "Add [description of your changes]"

6. Push to Your Fork

Push your changes to your forked repository:

git push origin feature/your-feature-name

7. Open a Pull Request

Submit your changes for review:

  1. Go to the original repository: Competitive Programming 101.
  2. Click on the Pull Requests tab.
  3. Click on New Pull Request.
  4. Select your branch and provide a detailed description of your changes.

8. Collaborate

  • Address any feedback or requested changes from reviewers.
  • Once approved, your contribution will be merged into the main branch.

💡 Tips for Contributors

  • Follow a consistent coding style.
  • Write clear and concise commit messages.
  • If you're unsure about your contribution, open an issue to discuss it first.

🤝 Code of Conduct

This project is governed by the Code of Conduct. By participating, you agree to uphold a welcoming and inclusive environment.

🌟 Thank You!

Your contributions make a difference! We appreciate your time and effort in improving Competitive Programming 101. If you have any questions, feel free to open an issue or contact the maintainers.

Happy coding! 🚀