Skip to content

Latest commit

 

History

History
76 lines (44 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

76 lines (44 loc) · 4.72 KB
Raw

Welcome to Michelle Mounde's Portfolio contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on michellemounde.dev ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

To navigate our codebase with confidence, fork and install the project to familiarize yourself with the code 🎊.

Check to see what type of contribution you are comfortable with before making changes. Some of them don't even require writing a single line of code ✨.

Issues

Create a new issue

If you spot a problem with the application, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

  1. Fork the repository.

  • Using GitHub Desktop:

  • Using the command line:

    • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

  1. Install or update using npm i or npm install commands.

  2. Create a working branch and start with your changes!

Commit your update

  • Ensure you have good commits using conventional commits as this will speed up the review process.

Commit the changes once you are happy with them. Don't forget to self-review your work to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can make the changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The GitHub team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the Portfolio.

Now that you are part of the GitHub docs community, feel free to contribute more.