Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

Latest commit

 

History

History
52 lines (29 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

52 lines (29 loc) · 2.47 KB

Welcome to contributing guide

New contributor guide

To gain a comprehensive understanding of the project, refer to the README. The following resources are available to assist you in making open source contributions:

Getting started

Issues

Create a new issue

In case of encountering any issues, search for existing issues before opening a new one. If no related issue exists, create a new one using the relevant issue form.

Solve an issue

Examine our existing issues to identify one that piques your interest.

Make Changes

Commit your update

Commit the changes when you are satisfied with them. Remember to conduct a self-review to accelerate the review process:zap:.

Self-review

Conduct a self-review of your PR before submitting it for review by others.

Ensure the following when making content changes:

  • Make sure to concentrate on a single goal in each PR to ensure its success and to maintain a well-structured codebase.
  • Ensure that your PR and commits are written in English and have clear and concise titles and descriptions.
  • Resolve any failing checks, errors, or warnings in your PR until all are passing.
  • Create separate PRs/Commits for each folder when making changes. For example, if you make changes in JavaScript and TypeScript, create a separate PR for each rather than combining them into a single PR.

Pull Request

When you have completed the changes, submit a pull request (PR) for review.

Your PR is merged!

Congratulations 🎉🎉! The Permaweb community and I express our gratitude ✨.

Upon merging of your PR, your contributions will become publicly accessible within this repository, with recognition given to your GitHub profile as a contributor in the README.md.

Now that you are part of the Permaweb Vue community, see more here (Cookbook Permaweb)[https://cookbook.arweave.dev/]