Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 4.58 KB

CONTRIBUTING.md

File metadata and controls

74 lines (44 loc) · 4.58 KB
Raw

Welcome to esm-module-alias docs contributing guide

Thank you for investing your time in contributing to our project ✨

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.

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

Issues

Create a new issue

If you spot a problem with the docs, 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. See Labels for more information. 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 in a codespace

For more information about using a codespace for working on GitHub documentation, see "Working in a codespace."

Make changes locally

  1. Install Git.

  2. 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 Node.js.

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

Commit your update

Commit the changes once you are happy with them. Don't forget to self review what you did!

Pull Request

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

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • 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 Docs 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 apply suggested changes directly through the UI. You can make any other 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 🎉🎉 You have successfully made a contribution to the docs! ✨

Contacts

If you have any questions, you can contact the maintainer at the email euberdeveloper@gmail.com.