Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 2.73 KB

Welcome to the Neo4j Starter Kit contributing guide

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

Read our Code of Conduct to keep our community friendly and respectable.

In this guide you will get a brief overview of the contribution workflow from opening an issue, creating a PR, the review process and the merge of a PR.

Getting started

Issues

If you have a bug to report or feature to request, first search to see if an issue already exists. If a related issue doesn't exist, please raise a new issue.

If you don't have a bug to report or feature request, but you need a hand with the code; community support is available via Neo4j Online Community and/or Discord.

Make changes

  1. Fork the respository.
  2. Create a working branch and start with your changes!

Pull request

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

  • Ensure that you have signed the CLA for a non-trivial patch or pull request.
  • Don't forget to link your PR to an issue if you are solving one.
  • Try to resolve a issue in a single commit. Use Squash and Merge on GitHub
  • Enable the checkbox to allow maintainer edits so that maintainers can make any necessary tweaks and update your branch for merge.
  • Reviewers may ask for changes to be made before a PR can be merged, either using suggested changes or normal pull request comments. You can apply suggested changes directly through the UI, and any other changes can be made in your fork and committed to the PR branch.
  • As you update your PR and apply changes, mark each conversation as resolved.

Your PR is merged

Congratulations and thank you for your contribution! 🎉