Skip to content

Latest commit

 

History

History
85 lines (61 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

85 lines (61 loc) · 2.79 KB
Raw

Contributing to GeeksforGeeks-POTD

Thank you for considering contributing to GeeksforGeeks-POTD! We welcome all types of contributions, whether it's fixing bugs, adding new features, improving documentation, or simply suggesting improvements. Please follow the guidelines below to help us maintain a high-quality codebase.

Table of Contents

Getting Started

  1. Fork the repository from here.
  2. Clone your forked repository: 
    git clone https://github.com/your-username/GeeksforGeeks-POTD.git
  3. Navigate to the project directory: 
    cd GeeksforGeeks-POTD
  4. Create a new branch for your feature or bug fix: 
    git checkout -b your-branch-name

How to Contribute

Adding a New Feature or Fixing a Bug

  1. Ensure your code follows the project's coding standards and conventions.
  2. Write or update tests as necessary.
  3. Ensure all tests pass before submitting your changes.

Improving Documentation

  1. Check the Code Properly & grammar, spelling, and clarity.
  2. Add or update code examples as necessary.

Code Style

Please follow these guidelines to maintain a consistent codebase:

  • Use meaningful variable and function names.
  • Write comments where necessary, especially for complex logic.
  • Format your code using a linter (e.g., C++, Java, Python).
  • Follow the project's existing coding style.

Pull Request Guidelines

  1. Ensure your branch is up to date with the main branch: 
    git checkout main
git pull origin main
git checkout your-branch-name
git rebase main
  2. Push your branch to your forked repository: 
    git push origin your-branch-name
  3. Open a pull request on the main repository. Provide a clear and descriptive title and description of your changes.
  4. Link any related issues in your pull request description.
  5. Ensure your pull request passes all checks and reviews.

Issue Reporting

If you encounter any issues or have suggestions for improvements, please open an issue on the Issues page. Provide as much detail as possible, including steps to reproduce the issue, if applicable.

Contact

If you have any questions or need further assistance, feel free to contact the project maintainers.

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming and respectful community.

Thank you for your contributions!

Happy Coding!