Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

91 lines (58 loc) · 4.2 KB
Raw

🧑‍💻 Contributing to gha-pre-commit-update

Welcome to gha-pre-commit-update! This document contains the instructions on how to contribute to gha-pre-commit-update.

🔥 Quicklinks

🎬 Getting started

Contributions are made to this project using Issues and Pull Request (PRs). Before creating your own, search for existing Issues and PRs - as I'm sure you're aware, this removes duplication and makes everyone's life easier!

😭 Issues

Issues should be used to report bugs with gha-pre-commit-update, proposing new features before a PR is raised, and to request new features. We're making use of templates to make this process easier for you and consistent for everyone - this will appear when you create an issue.

If you find an issue that has already been reported by another good samaritan, then please add your own reproduction information to the existing issue rather than creating a new one. Reacting to issues can also help our maintainers understand that the issue is affecting more than one reporter.

🎫 Pull Requests

Pull Requests (PRs) are how contributions are made to gha-pre-commit-update and are always welcome.

The preferred way to contribute to gha-pre-commit-update is to fork the main repository on Github and then submit a pull request.

🖥️ Getting setup locally

Here, we'll explain to get setup locally with gha-pre-commit-update and how to set up your git repository:

  1. If you don't already have one, create an account on Github.

  2. Fork the repository by clicking on the 'fork' button near the top of the page. What this will do is create a copy of the gha-pre-commit-update repository under your Github account. See here for a guide on how to fork a repository.

  3. Clone this forked version of gha-pre-commit-update to your local disk:

git clone [email protected]:<your_username>/gha-pre-commit-update.git
cd `gha-pre-commit-update`
  1. Add the upstream remote. Adding this means you can keep your repository sync'd with the latest changes to the main repository:
git remote add upstream [email protected]:fuzzylabs/gha-pre-commit-update.git
  1. Check that these remote aliases are correctly configured by running: git remote -v, this should show the following:
origin  [email protected]:<your_username>/gha-pre-commit-update.git (fetch)
origin  [email protected]:<your_username>/gha-pre-commit-update.git (push)
upstream        [email protected]:fuzzylabs/gha-pre-commit-update.git (fetch)
upstream        [email protected]:fuzzylabs/gha-pre-commit-update.git (push)
  1. Sync your main branch with the upstream/main branch:
git checkout main
git fetch upstream
git merge upstream/main
  1. Create your feature branch which will contain your development changes:
git checkout -b <your_feature>

and you can now start making changes! We're sure that you don't need reminding but it's good practise to never work on the main branch and to always use a feature branch.

  1. Develop your feature on your computer and when you're done editing, add the changed files to git and then commit:
git add <modified_files>
git commit -m '<a meaningful commit message>'

Once committed, push your changes to your Github account:

git push -u origin <your_feature>
  1. Once you're finished and ready to make a pull request to the main repository, then follow the steps below

🤔 Making a pull request

Before a PR can be merged, two core developers need to approve it. The core developer team handle the review process and will be notified when a new PR is submitted.

It may be the case that you have an incomplete contribution, where you're expecting to do more work before receiving a full review. In this case please use the draft PR functionality within GitHub. These types of PRs often benefit from including a task list in the PR description.