Home

Getting help

The primary source of information is the documentation available at http://elfi.readthedocs.io/. Limited user-support may be asked from elfi-support.at.hiit.fi.

If you find bugs or have other technical requests, please open an Issue.

Feature branches

Each feature branch should have: - branch name (short, descriptive, unique) - description of the feature - person responsible for managing the feature

Development guidelines

Adding a new feature

• Discuss if feature should be added
• If there are people supporting the idea, create a feature branch to main repo (from dev branch)
• Add feature data to list of feature branches

Contributing to an existing feature

• Pick a feature to work on
• Fork the main repository, checkout your version of the feature branch
• Develop code
• Push commits to your fork
• Make a pull request from your repo feature branch to main repo feature branch
• Wait until PR accepted; make changes if needed

Making a small change / bugfix (smaller than a feature)

• Fork the main repository, checkout dev branch
• Develop code
• Push commits to your fork
• Make a pull request from your repo dev branch to main repo dev branch
• Wait until PR accepted; make changes if needed

Merging a feature

• Make a pull request from main repo feature branch to main repo dev branch
• Wait until PR accepted by majority vote of core developers; make changes if needed

Making a release

• Make a pull request from main repo dev branch to main repo master
• Wait until PR accepted by all core developers; make changes if needed
• Add release version tag to main repo master branch
• Publish new version to pypi

For more details, please read the CONTRIBUTING.rst file.