Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 4.57 KB

CONTRIBUTING.md

File metadata and controls

79 lines (54 loc) · 4.57 KB
Raw

Contributing to SMAC3

You are interested in developing a new feature or have found a bug? Awesome, feel welcome and read this guide in order to find out how to best report your ideas so that we can include them as quickly as possible.

General Notes

We are always happy to read about your experiences and ideas on how to improve SMAC3. We use the issue tracker as our main communication platform, so please open an issue to

  • report bugs (label as bug)
  • ask usage questions (label as question)
  • discuss feature requests (label as request)
  • let us know if you plan to contribute code

NOTE: Before working on a new feature please first create an issue. If the relevant issue already exists, please comment that issue to let us know that you are going to work on it. Through that, we can ensure that there is no duplicated effort.

New Features

If you are looking for feature that does not yet exist in SMAC3, we are happy to hear about it. Open an issue on our issues list on GitHub, and describe

  • the feature you would like to see
  • why you need it and
  • how it should work.

If you already know how to implement the feature, please create a pull request. Please see the Pull request section, to read further details on pull requests.

Report Bugs

Open an issue in our issue list on GitHub.

Before you report a bug, please make sure that:

  1. Your bug hasn't already been reported in our issue tracker.
  2. You are using the latest SMAC3 version.

If you found a bug, please provide us the following information:

  • A description of the problem
  • An example to reproduce the problem
  • Any information about your setup that could be helpful to resolve the bug (such as installed python packages)
  • Feel free, to add a screenshot showing the issue, if it helps.

Work on New Features

To work on new features, create a fork of the original repository and implement the feature there. When you are happy with the final result you can create a pull request which we will review. A good tutorial on how to do this is in the GitHub Guide: Fork a repo.

Pull Requests

The target branch for your pull request has to be the development branch. If you have not worked with pull requests, please take a look at how to Contribute to an Open Source Project on GitHub or read more about it in the official GitHub documentation https://help.github.com/articles/about-pull-requests/

If you know how to fix a bug or implement your own feature, follow this small guide:

  • Check the issue tracker if someone has already reported the same idea or found the same bug.
  • Create a pull request, after you have implemented your changes in your fork. Using a separate branch for the fix is required.
  • Pull request must include tests.
  • We are using the Numpy Style Python Docstrings. Take a look at this example.
  • The code should follow the PEP8 coding convention.
  • Check that the copyright notice of all files that have been significantly changed includes the current year.

We try to react as fast as possible to your pull request.

Git-Flow Workflow and Branch-Naming

We aim to approximately follow the Git-Flow Workflow. Thus, the following conventions apply:

Branches are named as follows:

  • main The main branch, containing the latest stable release (tagged)
  • development The development branch, for merging features and bugfixes in-between releases
  • release/<version> Release branches for preparing a new release (no new features developed here), deleted after release
  • feature/<feature-name> Feature branches for implementing new functionality, updating existing functionality or fixing bugs on the development branch
  • hotfix/<bug-name> Hotfix branches for fixing bugs in the latest release
  • support/<version> Support branches for bugfixes in older releases (e.g., support/v0.12.x). New 'old' versions are tagged here.
  • gh-pages The branch for the GitHub pages

Reporting Security Issues

If you find security related issues, vulnerabilities or bugs including sensitive information, please do not report this to the issue tracker, or elsewhere public. Instead, please let us know via [email protected]