Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (63 loc) · 3.69 KB

CONTRIBUTING.md

File metadata and controls

103 lines (63 loc) · 3.69 KB
Raw

Contributing to RudderStack

Thanks for taking the time and for your help improving this project!

Getting Help

If you have a question about rudder or have encountered problems using it, start by asking a question on discord.

Rudder Labs Contributor Agreement

To contribute to this project, we need you to sign to 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.

Installing and Setting Up RudderStack

To contribute to this project, you need to install RudderStack on your machine. By following a few simple instructions, you can get your machine up and running to use RudderStack in no time.

  1. Download and install Golang 1.13 or above.

  2. Download and install Node.js 10.6 or above.

  3. Download and install PostgreSQL 10 or above, and set up the database using the following commands:

createdb jobsdb
createuser --superuser rudder
psql "jobsdb" -c "alter user rudder with encrypted password 'rudder'";
psql "jobsdb" -c "grant all privileges on database jobsdb to rudder";

  1. Go to the RudderStack dashboard and set up your account. Copy your workspace token from the top of the home page.

  2. Clone the RudderStack server repository. Run git submodule init and git submodule update to fetch the rudder-transformer repository. Then, navigate to the transformer directory using the following command:

cd rudder-transformer
  1. Install dependencies using the command npm install and start the destination transformer using the following command:
npm start
  1. Navigate back to the main directory using the following command:
cd rudder-server
  1. Copy the sample.env to the main directory using the following command:
cp config/sample.env .env

  1. Update the WORKSPACE_TOKEN environment variable with the workspace token fetched from the RudderStack dashboard.

  2. Run the backend server using the following command:

go run -mod=vendor main.go

Once you have successfully followed the steps above, follow our guide on How to Send Test Events in order to test if there are any issues with the installation.

There you go! You can now start using RudderStack on your machine.

Submitting a Pull Request

Do you have an improvement?

  1. Submit an issue describing your proposed change.
  2. We will try to respond to your issue promptly.
  3. Fork this repo, develop and test your code changes. See the project's README for further information about working in this repository.
  4. Submit a pull request against this repo's master branch.
    • Include instructions on how to test your changes.
  5. Your branch may be merged once all configured checks pass, including:
    • A review from appropriate maintainers

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.

We look forward to your feedback on improving this project.