Doppler is work of many people. You're encouraged to submit pull requests, propose features and discuss issues.
Fork the project on Github and check out your copy.
git clone https://github.com/contributor/doppler.git
cd doppler
git remote add upstream https://github.com/artsy/doppler.git
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
git checkout main
git pull upstream main
git checkout -b my-feature-branch
Ensure that you can build the project and run tests.
Note: Modern Firefox support for selenium-webdriver is troubled as of January 2017.
A compatible older version of Firefox is available here.
bundle install
bundle exec rake
You can run Doppler against an Artsy production environment, however we recommend playing with staging. Please note that staging is rebuilt weekly and does not have 100% uptime. Staging has a copy of production data, so if you create a user or an application in production on artsy.net, it will be made available in staging in 7 days. Please also note that staging doesn't send e-mail, so some features may not work.
To run Doppler you need a client ID and secret, which you can obtain from developers-staging.artsy.net. Please note that staging is rebuilt weekly, so all your test data will be lost.
Create a .env file.
ARTSY_API_URL=https://stagingapi.artsy.net
ARTSY_API_CLIENT_ID=...
ARTSY_API_CLIENT_SECRET=...
JWT_SECRET=...
Run foreman start.
Navigate to http://localhost:5000.
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to spec/features.
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
Implement your feature or bug fix.
Ruby style is enforced with Rubocop, run bundle exec rubocop and fix any style issues highlighted.
Make sure that bundle exec rake completes without errors.
Make sure git knows your name and email address:
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
Writing good commit logs is important. A commit log should describe what changed and why.
git add ...
git commit
git push origin my-feature-branch
Go to https://github.com/contributor/doppler and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
If you've been working on a change for a while, rebase with upstream/main.
git fetch upstream
git rebase upstream/main
git push origin my-feature-branch -f
We like neat commits, please try to amend your previous commits and force push the changes.
git commit --amend
git push origin my-feature-branch -f
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
Please do know that we really appreciate and value your time and work. We love you, really.