Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (54 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

82 lines (54 loc) · 2.44 KB

Contribution

Want to Contribute? Great

  • Select an Issue and get yourself assigned
  • Follow the below guidelines in this file to make proper PRs

  1. Fork the Repository

    Create a fork of this repository by clicking the "Fork" button at the top of the repository page on GitHub.

  2. Clone Your Fork

    Clone the forked repository to your local machine:

    git clone https://github.com/AbhilashK26/Codebase.git
cd Codebase

  3. Create a Branch Create a new branch for your feature or bugfix:

    git checkout -b feature/YourFeatureName

  4. Make Your Changes

    Write clean, readable, and well-documented code. Ensure that the code passes all tests and follows the project's coding standards. You can also attach a working video to demonstrate your changes.

  5. Commit Your Changes

    git add <file_name>
git status
git commit -m "Add YourFeatureName"

  6. Sync your forked repository with the original repository

    Go to the forked repository on GitHub, click on "Sync fork" tab and update your forked repository with the original repository.

  7. Pull from main branch of the forked repository

    Before pushing your changes, always pull from the main branch of the forked repository.

    git pull origin main

    Resolve the merge conflicts locally if any.

  8. Commit again if there was any merge conflict

     git add <file_name>
 git status
 git commit -m "Describe about the changes"

  9. Push your changes

    Now push your changes to the remote repository.

    git push origin feature/YourFeatureName

  10. Create a Pull Request

    Go to the original repository on GitHub, click on the "Pull Request" tab, and submit your pull request. Include a detailed description of the changes you made and` why they should be merged.

    While making a PR, follow Pull_request_template.md to get your pull request accepted.

  11. Reporting Issues

    If you find a bug or want to suggest a feature:

    • Search Existing Issues: Check if there is already an open issue for your query. Avoid duplicating issues if possible.

    • Open a New Issue: If your issue is unique, open a new issue and describe it in detail. Include steps to reproduce, if applicable, and suggested improvements.

Thank you for contributing to Codebase! Happy Coding!