Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 2.12 KB
Raw

Contributing

We love pull requests from everyone. By participating in this project, you agree to abide by the thoughtbot code of conduct.

We expect everyone to follow the code of conduct anywhere in thoughtbot's project codebases, issue trackers, chatrooms, and mailing lists.

  1. Fork the repo.

  2. Run ./bin/setup.

  3. Run appraisal install

  4. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate: bundle exec rake && bundle exec appraisal rake

  5. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!

  6. Make the test pass.

  7. Write a good commit message.

  8. Push to your fork and submit a pull request.

Others will give constructive feedback. This is a time for discussion and improvements, and making the necessary changes will be required before we can merge the contribution.

Start Application in Development

Configure your local environment with ./bin/setup. After that start the application with the foreman start command.

Performance Improvements

Improving our users' experience should be the primary goal of any optimization.

If you contribute a performance improvement, you must submit performance profiles that show that your optimizations make a significant impact on Administrate's request times.

Request-level profiles are our best measure of how users experience our app. Many other performance measurements, such as benchmarks, can give inaccurate impressions of an optimization's overall impact.

Tools like Rack MiniProfiler are helpful for generating request-level performance profiles.

Security

For security inquiries or vulnerability reports, please email security@thoughtbot.com. If you'd like, you can use our PGP key when reporting vulnerabilities.