|
68 | 68 | This can be done in one go in an isolated environment. Just run `tox`.
|
69 | 69 | Add `-p auto` to parallelize for all test-environments, `-e py<yourversion>` to only test against a single version of python.
|
70 | 70 |
|
| 71 | +- Do not merge user-visible changes without documenting them in the changelog. Also create/request a release from the |
| 72 | + old version if it does not exist yet. |
| 73 | + |
| 74 | +- Before merging a pull-request, make sure that at least one other person has reviewed or at least |
| 75 | + sanity checked the changes. |
| 76 | + |
| 77 | +- Please use meaningful commit-messages, describe what and if necessary how you changed things. Not just "Fixed Stuff". |
| 78 | + |
| 79 | +- When opening a pull request, please make sure all changes are self-contained and complete. In case you made some |
| 80 | + incidental fixes put them in a separate branch |
| 81 | + (e.g. by cherry-picking/ interactive rebasing the desired changes onto new branches. |
| 82 | + |
| 83 | +- Unless traffic in this repo increases dramatically, you don't squash changes before merging. |
| 84 | + Merged branches can be deleted |
| 85 | + |
| 86 | +### Codestyle |
| 87 | + |
| 88 | +- Style follows PEP8, with the exception of line-length of 120 characters |
| 89 | + |
| 90 | +- Docstrings, especially for functions, follow to the numpy guidelines. |
| 91 | + |
| 92 | +- Prefer meaningful variable names over abbreviations. E.g. `magnitude, flux, flux_error` over `m, f, df` unless |
| 93 | + its very clear from context (`for i in range(...):`) or established notation. |
| 94 | + |
| 95 | +- Write at least basic smoke-tests (i.e. "if I run this, does it explode right away?") for new functionality and when |
| 96 | + refactoring existing code. |
| 97 | + |
| 98 | +## Changelog |
| 99 | + |
| 100 | +###v1.0 |
| 101 | +Initial release |
| 102 | + |
| 103 | +### unreleased Changes |
| 104 | + |
| 105 | +- (example) Testdata available as package resources: `mascado.resources.example_files` |
| 106 | + |
71 | 107 | ## License
|
72 | 108 |
|
73 | 109 | Copyright 2018 Hannes Riechert <[email protected]>
|
|
0 commit comments