Adding license, and contributing guidelines from #72 and #65 #74
Conversation
Signed-off-by: John St John <[email protected]>
|
/build-ci |
Signed-off-by: John St John <[email protected]>
| Add unit tests under `tests` to examine use cases of new classes or methods that are being added to the codebase. Each | ||
| test file must be for a particular file or module. For example if you have a file that is under | ||
| `src/path/to/module/my_file_name.py` then your test should match the path at `tests/path/to/module/test_my_file_name.py`. | ||
| Check the tests folders in the sub-modules of this repository for examples. If you are testing a module, such as | ||
| integrating multiple examples of different files, then you can use the following pattern to test the module, say in the | ||
| above example, if you wanted to test functions from several files together that all exist in the same `src/path/to/module` | ||
| then you could create a `tests/path/to/test_module.py` file. The same is true for parents of that module and so on. | ||
| Generally unit tests should exist at the level of the individual file however. |
There was a problem hiding this comment.
This can wait, but at some point if we get larger it would be good to have a short section on "what makes a good test". Specifically, it would be nice to talk about test naming, self-contained tests, and short runtimes as being important. Eventually it would be nice to break out integration / gpu-dependent tests into their own bucket as well
| * To sign off on a commit you simply use the `--signoff` (or `-s`) option when committing your changes: | ||
| ```bash | ||
| $ git commit -s -m "Add cool feature." | ||
| ``` | ||
| This will append the following to your commit message: | ||
| ``` | ||
| Signed-off-by: Your Name <[email protected]> | ||
| ``` |
There was a problem hiding this comment.
it would help to add guidance on how to retroactively sign commits.
…n/address_license_dco Signed-off-by: John St. John <[email protected]>"
Signed-off-by: John St John <[email protected]>
Just a note, we have a googledoc and devcontainer setup for this now. |
|
/build-ci |
|
/build-ci |
Address issue #72 and #65.