Thank you for investing your time in contributing to our integration platform! Any contribution you make will be reviewed by our team.
In this guide, you'll learn the differnt ways you can contribute to our platform!
This repository contains code related to different parts of our integration platform. Depending on what you'd like to contribute to, head to the section below to find the necessary steps.
If you spot a problem within a repository, search if an issue already exists. If a related issue doesn't exist, you can open a new issue here!
Please make sure any added issues are
- Descriptive
- Thoughtful
- Organized
We recommend adding as many relevant links, minimal reproductions of the issue, and other materials that will help our team solve the issue fast.
If you're interested in solving an issue in our repository, start by scanning through it's exisiting issues to find one that you're interested in working on. If you find an issue to work on, you are welcome to open a PR with a fix. See the following sections below for more information on contributing for specific sections.
The official developer docs for GitBook, hosted on https://developer.gitbook.com/. Our documentation uses one of GitBook's most useful features-Git Sync!
Git Sync allows you to keep your GitBook site up to date with a remote repository either on GitHub or GitLab. In our case we have the /docs directory synced with https://developer.gitbook.com/. This means that any changes reviewed, approved, and merged into this directory will automatically be deployed!
The integrations found in this repository are owned and maintained by the GitBook organization. If you're interested in creating your own integration - you can! Head to our getting started guide to build your first integration.
If you're interested in contributing to any of our already published integrations that live in /integrations, you're more than welcome to add or update any changes you think would make our integrations better. Every contribution will be reviewed and tested by our team.
You're also welcome to contribute updates or improvements to the packages living in /packages. Head to each package's documentation page to learn more about what each one does.
@gitbook/cli: https://developer.gitbook.com/cli/quickstart
@gitbook/api: https://developer.gitbook.com/gitbook-api/librairies/browser-node
@gitbook/runtime: https://developer.gitbook.com/integrations/reference
To start, make sure you have the appropriate tooling installed on your machine:
- 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.
- Create a working branch and start with your changes!
Commit your changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages!
Once your changes are ready, don't forget to self-review your code to double check that your chagnes are ready to be added.
When you're finished with the changes, create a pull request, also known as a PR.
- 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 GitBook 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 🎉
Thank you for your contribution! Once your PR is merged, your contributions will be publicly visible on the relevant repository.