Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

95 lines (73 loc) · 3.56 KB
Raw

Contributing to First Pull Request

Thank you for your interest in contributing to First Pull Request!

Below is step-by-step instruction how to fix a bug in our javascript code. If something is still unclear please ask questions in https://github.com/alex1yaremchuk/first-pull-request/discussions.

Basic contributions (namely amending the text/changeme.md file) is described in [CONTRIBUTING-LIGHT.md].

  1. Fork the Repository: Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.

  2. Clone Your Fork:

    git clone https://github.com/your-username/project-name.git
cd project-name

  3. Make a new branch: Use the following format for branch names:

  • feature/<short-description>
  • fix/<short-description>
  • chore/<short-description>
  • docs/<short-description> 
    git checkout -b fix/my-first-fix

  1. Install Dependencies: After you forked and cloned the repo, you're ready to install Node.js dependencies of this project.

    cd javascript
npm install

  2. Fix the bug: Fix the issue in the code.

  3. Run Tests and Linting locally: Make sure testing and linting is successful after your change.

    npm test
npm run lint

  4. Commit Your Changes: Use Conventional Commits format:

    type(scope): description
  • type: feat, fix, docs, chore, refactor, test
  • scope: (optional) The area of code affected
  • description: Short and imperative

In the description you can mention issue number, in this case issue gets automatically closed when PR is merged.

```sh
git add .
git commit -m "fix: Fixes #N"
```

  1. Push the changes: This step will push your changes to your forked repository. (Still need to put changes to this original repo with PR!)

    git push

  2. Create a Pull Request: GitHub will show a banner at the top of your repo's main page saying that there is a branch and suggesting to create a PR for it. Or you could go to "Pull requests" tab and create new pull request there.
    In the description you can add text "Closes #123" where 123 is number of opened issue on your fix. It can be done either here or in commit message.

  3. Follow your PR: We will review and merge your pull request in due course. You'll see your changes in this repo and your name among contributors. And [https://alex1yaremchuk.github.io/first-pull-request/index.html](this page) shows more decent arithmetics.

  4. Merge Conflicts (hopefully not!): If it happens that upstream repo went forward by the time your changes are ready to be merged, then you'll need to merge or rebase your changes. First command sets this repo as an upstream remote in your cloned repo. Second one fetches changes from this repo and merges them into your cloned repo's main branch. Then you have a merge commit which needs to be pushed to your origin remote(and into pull request automatically). Now pull request can be merged.

    git remote add upstream https://github.com/alex1yaremchuk/first-pull-request.git

git pull upstream main

If it sounds too much then you can simply abandon your current branch and PR and create a new one (repeat from step 3). But still you'll need to pull recent changes from upstream with the above commands.

Code of Conduct

Please adhere to the Code of Conduct in all your interactions with the project.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.