Skip to content

Latest commit

 

History

History
142 lines (97 loc) · 5.86 KB

CONTRIBUTING.md

File metadata and controls

142 lines (97 loc) · 5.86 KB
Raw

Contributing Guidelines

Please "star" this repo. Watch the video here

When contributing to this repository, it is essential to first discuss the proposed changes with the project maintainers via issue to ensure alignment with the project's goals.

Please adhere to our Code of Conduct during all interactions within the project.

Pull Request Process

  1. Dependency Management: Before concluding a build, ensure that all installation or build dependencies are removed. Commit only relevant files to maintain repository cleanliness, disregarding the rest.

  2. Update README.md: Detail any changes to the interface in the README.md file. This includes information such as new environment variables, exposed ports, useful file locations, and container parameters.

  3. Review Request: Once a Pull Request (PR) is submitted, request a review from the project maintainers to facilitate timely feedback and integration.

Git Workflow

Step 1: Fork Repository

Step 2: Git Setup & Repository Download

# Clone the repository
$ git clone https://github.com/<User-Name>/<Repo-Name>.git

# Add upstream remote
$ git remote add upstream https://github.com/ashutosh-rath02/git-re.git

# Fetch and merge with upstream/master
$ git fetch upstream
$ git merge upstream/master

Step 3: Create and Publish Working Branch

$ git checkout -b <type>/<issue|issue-number>/{<additional-fixes>}
$ git push origin <type>/<issue|issue-number>/{<additional-fixes>}

Types:

  • wip: Work in Progress; mainstream changes; long-term work.
  • feat: New Feature; non-mainstream changes; future planned.
  • bug: Bug Fixes.
  • exp: Experimental; random experimental features.

On Task Completion

# Ensure on the branch
$ git branch

# Fetch and merge with upstream/master
$ git fetch upstream
$ git merge upstream/master

# Add untracked files
$ git add .

# Commit changes with appropriate message and description
$ git commit -m "your-commit-message" -m "your-commit-description"

# Fetch and merge with upstream/master again
$ git fetch upstream
$ git merge upstream/master

# Push changes to your forked repository
$ git push origin <type>/<issue|issue-number>/{<additional-fixes>}

Creating the Pull Request (PR) using GitHub Website

  • Create a PR from <type>/<issue|issue-number>/{<additional-fixes>} branch in your forked repository to the master branch in the upstream repository.
  • After creating the PR, add a Reviewer (Any Admin) and yourself as the assignee.
  • Link the PR to the appropriate Issue or Project+Milestone if no issue has been created.
  • Important: Do Not Merge the PR unless specifically instructed by an admin.

After PR Merge

  • Delete the branch from the forked repository.
  • Clean up the local environment by updating the master branch.
$ git branch -d <type>/<issue|issue-number>/{<additional-fixes>}
$ git push --delete origin <type>/<issue|issue-number>/{<additional-fixes>}
$ git checkout master
$ git pull upstream
$ git push origin

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.

Need some help regarding the basics?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

Always adhere to commit message standards and maintain a consistent style.