Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (36 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 3.51 KB

Welcome to ENS docs contributing guide

Thank you for investing your time in contributing to our documentation! Any contribution you make will be reflected on docs.ens.domains ✨.

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

Note

Please be aware that we will not be merging any pull requests that appear to be an attempt to farm activity on low-effort contributions from suspicious-looking accounts.

Getting started

This guide will walk you through the process of contributing to the ENS docs. If you are new to GitHub, you can checkout this GitHub tutorial to get 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.

Solve an issue

Scan through our existing issues to find one that interests you. 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 the UI

Click Make a contribution at the bottom of any docs page to make small changes. This takes you to the .mdx file where you can make your changes and create a pull request for a review.

Make changes locally

Note

Node.js version 20 or higher is required to build the docs.

  1. Fork the repository via the GitHub UI.
  2. Clone your forked repository to your local machine.
  3. Create a working branch and make your changes!
  4. For a fresh clone, run pnpm install
  5. Build the docs locally with pnpm run build to ensure your changes are valid.

Optionally, serve on local host with pnpm run dev to view your build in the browser.

Commit your update

Commit the changes once you are happy with them. Upon creating a Pull Request your code will automatically be tested ⚡.

Pull Request

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

  • 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 🎉🎉 The ENS team thanks you ✨.

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