Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

Latest commit

 

History

History
38 lines (26 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.81 KB
Raw

Contributing

Thanks for using and improving pwwka! If you'd like to help out, check out the project's issues list for ideas on what could be improved.

We're actively using Pwwka in production here at Stitch Fix and look forward to seeing Pwwka grow and improve with your help. Contributions are warmly welcomed.

If there's an idea you'd like to propose, or a design change, feel free to file a new issue or send a pull request:

  1. Fork the repo.
  2. Create a topic branch.
  3. Write tests.
  4. Implement your feature or fix bug.
  5. Add, commit, and push your changes.
  6. Submit a pull request.

General Guidelines

  • When in doubt, test it. If you can't test it, re-think what you are doing.
  • Code formatting and internal application architecture should be consistent.

Testing

The tests assume that:

  • Rabbit is running on port 10001
  • Redis is running on port 10003

You can achieve this by using Docker and running docker-compose up in the root of this directory. If you don't want to use Docker, that's fine. You'll need to set PWWKA_RESQUE_REDIS_PORT and PWWKA_RABBIT_PORT in your environment to the ports where those services are running.

Tests in spec/integration are end-to-end tests that use Rabbita and attempt to assert behavior from the point of view of the application owner. If you write tests here, depend on as few of Pwwka's internals as possible, and no mocking of anything.

Tests in spec/unit are more traditional unit tests and should not require Rabbit or Redis to be running.