CONTRIBUTING.md

genMDM Editor contribution guide

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

Read our Code of Coduct 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

See the README to get an overview of the project. Here are some helpful resources to get you comfortable with open source contribution:

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

Getting started

Before making changes, see what types of contributions we accept. Some of them don't require writing even a single line of code ✨.

Discussions

Got a question or want to share something about genMDM Editor? Have a look at our Discussions. Your question or topic may already exist. If not, create a new Discussion.

Issues

Create a new issue

If you spot a problem with genMDM Editor, 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.

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.

• GitHub Codespaces:

  • Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.

2. Install or update to Node.js v14.

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

Commit your update

Commit the changes once you are happy with them. See Conventional Commit's summary to know how to format commit and PR messages.

Once you are ready with your changes, don't forget to self review to quicken the review process ⚡.

Pull Request

When you're done making the changes, open a pull request, often referred to as a PR, on the next branch.

• Fill out the "Ready for review" template so we can review your PR. This template helps reviewers understand your changes and 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 genMDM Editor team member will review your proposal. We may ask questions or request for 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 🎉🎉

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

Now that you are part of the GitHub docs community, see how else you can contribute to the docs.