Thank you for your interesting in contributing to the StepZen Examples.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README. 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
Every example in this repository has its own directory, and includes StepZen GraphQL schema files and a README.md file. See TEMPLATE.md for an example.
If youmiss an example of using StepZen with another technology or service, you can open a new 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.
- 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.
-
Install or update to Node.js v16. For more information, see the development guide.
-
Create a working branch and start with your changes!
Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as 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 StepZen 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.
Congratulations 🎉🎉 The StepZen team thanks you ✨.
You can ask any question on the Discord here.