-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding README breadcrumbs in a couple of places. *Not* adding to ./sr…
…c or ./tests at this point.
- Loading branch information
Showing
3 changed files
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# The .github directory | ||
|
||
This directory contains various configurations and .yml files that are used to | ||
define GitHub actions and behaviors. | ||
|
||
## Workflows | ||
|
||
The .yml files in ``./workflows`` are used to define the various continuous | ||
integration scripts that will be run on your behalf e.g. nightly as a smoke check, | ||
or when you create a new PR. | ||
|
||
For more information about CI and workflows, look here: https://lincc-ppt.readthedocs.io/en/latest/practices/ci.html | ||
|
||
## Configurations | ||
|
||
Templates for various different issue types are defined in ``./ISSUE_TEMPLATE`` | ||
and a pull request template is defined as ``pull_request_template.md``. Adding, | ||
removing, and modifying these templates to suit the needs of your project is encouraged. | ||
|
||
For more information about these templates, look here: https://lincc-ppt.readthedocs.io/en/latest/practices/issue_pr_templating.html | ||
|
||
|
||
Or if you still have questions contact us: https://lincc-ppt.readthedocs.io/en/latest/source/contact.html |
12 changes: 12 additions & 0 deletions
12
python-project-template/{% if include_benchmarks %}benchmarks{% endif %}/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Benchmarks | ||
|
||
This directory contains files that will be run via continuous testing either | ||
nightly or after committing code to a pull request. | ||
|
||
The runtime and/or memory usage of the functions defined in these files will be | ||
tracked and reported to give you a sense of the overall performance of your code. | ||
|
||
You are encouraged to add, update, or remove benchmark functions to suit the needs | ||
of your project. | ||
|
||
For more information, see the documentation here: https://lincc-ppt.readthedocs.io/en/latest/practices/ci_benchmarking.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters