diff --git a/.github/README.md b/.github/README.md deleted file mode 100644 index 5fe2a015..00000000 --- a/.github/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# 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 \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 76e043ca..1da7077c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -22,42 +22,3 @@ If it fixes an open issue, please link to the issue here. If this PR closes an i ## Solution Description - - - -## Code Quality -- [ ] I have read the Contribution Guide -- [ ] My code follows the code style of this project -- [ ] My code builds (or compiles) cleanly without any errors or warnings -- [ ] My code contains relevant comments and necessary documentation - -## Project-Specific Pull Request Checklists - - -### Bug Fix Checklist -- [ ] My fix includes a new test that breaks as a result of the bug (if possible) -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) - -### New Feature Checklist -- [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) -- [ ] I have updated the tutorial to highlight my new feature (if appropriate) -- [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) - -### Documentation Change Checklist -- [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) - -### Build/CI Change Checklist -- [ ] If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this -- [ ] If this is a new CI setup, I have added the associated badge to the README - - - -### Other Change Checklist -- [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html). -- [ ] I have updated the tutorial to highlight my new feature (if appropriate) -- [ ] I have added unit/End-to-End (E2E) test cases to cover any changes -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) diff --git a/README.md b/README.md index bfa59a5c..59393d45 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,47 @@ -# fibad - +# FIBAD [](https://lincc-ppt.readthedocs.io/en/latest/) - -[](https://pypi.org/project/fibad/) [](https://github.com/lincc-frameworks/fibad/actions/workflows/smoke-test.yml) -[](https://codecov.io/gh/lincc-frameworks/fibad) -[](https://fibad.readthedocs.io/) -[](https://lincc-frameworks.github.io/fibad/) +[](https://codecov.io/gh/lincc-frameworks/fibad) -This project was automatically generated using the LINCC-Frameworks -[python-project-template](https://github.com/lincc-frameworks/python-project-template). +