Skip to content

Commit

Permalink
make release-tag: Merge branch 'master' into stable
Browse files Browse the repository at this point in the history
  • Loading branch information
pvk-developer committed Mar 4, 2020
2 parents 6224d2d + da9a745 commit 3fb4ef9
Show file tree
Hide file tree
Showing 23 changed files with 1,059 additions and 383 deletions.
27 changes: 18 additions & 9 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,27 @@ Get Started!
Ready to contribute? Here's how to set up `BTB` for local development.

1. Fork the `BTB` repo on GitHub.

2. Clone your fork locally::

$ git clone git@github.com:your_name_here/BTB.git
$ cd BTB/

3. Create a new [virtualenv](https://virtualenv.pypa.io/en/latest) for
development::

$ pip install virtualenv
$ virtualenv -p $(which python3.6) btb-venv
$ source btb-venv/bin/activate

Remember to activate your virtualenv before every development session!

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed,
4. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed,
this is how you set up your fork for local development::

$ mkvirtualenv btb
$ cd btb/
$ make install-develop

4. Create a branch for local development::
5. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature

Expand All @@ -82,33 +91,33 @@ Ready to contribute? Here's how to set up `BTB` for local development.

Now you can make your changes locally.

5. While hacking your changes, make sure to cover all your developments with the required
6. While hacking your changes, make sure to cover all your developments with the required
unit tests, and that none of the old tests fail as a consequence of your changes.
For this, make sure to run the tests suite and check the code coverage::

$ make lint # Check code styling
$ make test # Run the tests
$ make coverage # Get the coverage report

6. When you're done making changes, check that your changes pass all the styling checks and
7. When you're done making changes, check that your changes pass all the styling checks and
tests, including other Python supported versions, using::

$ make test-all

7. Make also sure to include the necessary documentation in the code as docstrings following
8. Make also sure to include the necessary documentation in the code as docstrings following
the `Google docstrings style`_.
If you want to view how your documentation will look like when it is published, you can
generate and view the docs with this command::

$ make view-docs

8. Commit your changes and push your branch to GitHub::
9. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

9. Submit a pull request through the GitHub website.
10. Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------
Expand Down
18 changes: 18 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# History

## 0.3.6 - 2020-03-04

This release improves `BTBSession` error handling and allows `Tunables` with cardinality
equal to 1 to be scored with `BTBSession`. Also, we provide a new documentation for
this version of `BTB`.

### Internal Improvements

Improved documentation, unittests and integration tests.

### Resolved Issues

* Issue #164: Improve documentation for `v0.3.5+`.
* Issue #166: Wrong erro raised by BTBSession on too many errors.
* Issue #170: Tuner has no scores attribute until record is run once.
* Issue #175: BTBSession crashes when record is not performed.
* Issue #176: BTBSession fails to select a proper Tunable when normalized_scores becomse None.

## 0.3.5 - 2020-01-21

With this release we are improving `BTBSession` by adding private attributes, or not intended to
Expand Down
Loading

0 comments on commit 3fb4ef9

Please sign in to comment.