Contributing

Contribute to Esky

Please don't ask question in the issue tracker, instead ask them at stackoverflow

File an issue

Please check esky's GitHub issue tracker for known issues.

Please try to follow these simple rules if applicable:

• Make sure you've read the README, Wiki and tutorial carefully.
• Provide information about your environment:
• Freezer being used
• Operating system
• Make sure that the issue is reproducible with your description.

It's most likely that your bug gets resolved faster if you provide as much information as possible!

Development

See our Roadmap for some tasks being worked on. Also of note is esky's network which will show you the branches and commits under development.

• Please create a topic branch for every separate change you make.
• Make sure your patches are well tested. All specs must pass when run on Travis CI.

Testing

To run tests locally run python -m pytest esky/tests/ (different tests run depending on the freezers you have installed, we have the following pytest marks: bbfreeze, cxfreeze, py2exe, pyapp

To run only certain tests python -m pytest -m cxfreeze to exclude certain tests python -m pytest -m "not cxfreeze"

• to exit after first error - x
• to enter python debugger after error --pdb
• for more info about which tests are being run -v

see pytest documentation

Constant Integration Testing

When you make a pull request,

• travis ci will run our tests on linux and display the results in the pull request
• appveyor will run our tests on windows, you will have to check the results manually