Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.32 KB
Raw

Contribution Rules

Welcome to Hacktoberfest!

We appreciate your interest in contributing to our open-source project. Before you start, please take a moment to read and understand the following guidelines to ensure a smooth and productive contribution process.

How to Contribute

  1. Fork the repository: Click the "Fork" button in the top right corner of this repository on GitHub.

  2. Clone your fork: Open a terminal and run the following command

git clone https://github.com/Namya13Jain/CPP_Guide.git

  1. Create a new Issue or contribute to an existing Issue. Wait for the issue to be assigned to you and then contribute to the repository.

  2. Make your changes: Write your code, fix a bug, or make improvements.

  3. Test your changes: Ensure your code works as expected and doesn't introduce new issues.

  4. Commit your changes: Commit your changes with a descriptive commit message:

git commit -m "Add feature: your feature name"
  1. Push your changes: Push your branch to your fork on GitHub:
git push origin feature/your-feature-name
  1. Create a Pull Request: Go to the original repository on GitHub and click the "New Pull Request" button. Fill out the necessary details, and we'll review your contribution.

Submitting Pull Requests

  1. Pull requests should be linked to an issue (if applicable).
  2. Include a clear and concise description of your changes in the pull request.
  3. Make sure your code is properly formatted and follows our coding standards.
  4. Keep your pull request focused on a single issue or feature to simplify the review process.

Best Practices for writing code

  1. While writing code, add comments to explain the working of the code.
  2. Use valid and logical variable names. Ex: Use int 'row' instead of int 'i' while using the for loop in the code of matrix multiplication
  3. Make use of Object Oriented Conecpts while solving data structures and algrothim problems.
  4. While contributing to the DSA folder, make sure to add the link of the coding problem at the top of the file in the form of a comment. Please give the complexity analysis(time complexity and space complexity) of the code you are contributing along with a brief explanation of the working of the code.
  5. While contributing to the OOPS folder, make sure to write a brief introduction of the topic along with an example.