CONTRIBUTING.md

Guitar Diagrams JS contributing guide

Thank you for your interest in contributing to Guitar Diagrams JS! As an open source project, contributions to the project will be attributed to contributors investing your time in contributing to our project! Any contribution you make will be reflected on the project's README.md page. ✨

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 file. Here are some resources to help you get started with open source contributions:

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Getting started

Start by familiarizing yourself with the documentation, including:

• docs/index.md: API usage documentation
• docs/examples/index.html: usage examples
• docs/CODE_OF_CONDUCT.md: code of conduct for contributing members

There are many ways you can contribute to the project, including opportunities that do not involve code, such as testing the project or reviewing documentation.

Issues

Create a new issue

If you find a bug or have a feature request, first search to see 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 "Label reference" 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 locally

1. Fork the repository.
   • Using GitHub Desktop:
     • Getting started with GitHub Desktop will guide you through setting up Desktop.
     • Once Desktop is set up, you can use it to fork the repo!
     • 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.
2. You can use whatever local development environment you prefer, but we recommend using Microsoft VS Code with the Live Server extension for easy previews.
3. 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 use the "Self review checklist" to speed up the review process ⚡.

Pull Request

When you're finished with the changes, create a pull request (PR) from your fork's branch into the main project's develop branch.

• 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 code owner will review your proposal. (Also, please update the issue with a comment and a link to your PR.) 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.