Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.52 KB

CONTRIBUTING.mdx

File metadata and controls

44 lines (27 loc) · 2.52 KB
Raw

Contributing to RudderStack

Thanks for taking the time and for your contribution for improving the documentation.

Table of contents

RudderStack Contributor Agreement

To contribute to this project, we would need you to sign the Contributor License Agreement (“CLA”) for the first commit you make. By agreeing to the CLA, we can add you to list of approved contributors and review the changes proposed by you.

Contributing to the docs

The RudderStack documentation is open source. This means that if you come across any issues or bugs or have any suggestions for improvement, you can navigate to the specific file in our docs repo, make the change, and raise a PR.

For instance, to create a PR for contributing to docs for a new third-party integration, follow these instructions on submitting an integration PR.

You can also submit an issue, give some context around it, and we will look into the issue immediately.

Committing

We prefer squash or rebase commits so that all changes from a branch are committed to master as a single commit. All pull requests are squashed when merged, but rebasing prior to merge gives you better control over the commit message.

Building the docs

We highly recommend building the docs locally to preview and test your changes before pushing them to your branch. To do so, you should have Gatsby version 4 or above and a fairly recent version of Node.js installed on your system.

  1. Clone this repo.
  2. Install the necessary dependencies with yarn install.
  3. Build a local version with yarn start.
  4. View your RudderStack Docs build at http://localhost:8001/.

Getting help

For any questions or concerns, you can start a conversation in our Slack community.

We look forward to your feedback on improving this project!