Implement CI/Testing Setup and Update README Requirements #9
Conversation
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
*Incorporation of the date filtering feature for the visualisation tool. By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
# *Add "import requests" in notebook.* ## ⚙️ Release Notes The **requests** module was added to the notebook. Inclusion of this module allows for sending a GET request to import the helpers.py file when using the "Open in colab" option. ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
# *Update SpeziDataPipeline.ipynb* ## ⚙️ Release Notes Missing comma resulted in unrecognised notebook file format. ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
- Badge does not link directly to the notebook - There is no check that the code conforms to the REUSE spec and no automated setup to execute the notebook - No initial CI setup * Renamed the setup to Spezi Data Pipeline Template (same as for our other projects); the eventual tool will be named Spezi Data Pipeline once we have defined a good public API * Updated the Codepilot badge to open the notebook without even having to select something. * Added GitHub Actions to test the REUSE Spec conformance & ensure that we properly license everything. * Added a test that checks that links in the markdown are all correct and don’t return a 404. * Added a setup that boots up the Firebase Emulator to do testing and run the notebook in the CI without accessing a production Firebase project. It allows us to export and import a set of mock data for testing purposes, which would be great to e.g., test the notebook in the CI: https://firebase.google.com/docs/emulator-suite/connect_firestore#import_and_export_data. See #5 for more detail. By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
PSchmiedmayer
approved these changes
Feb 28, 2024
Remove duplicate from License and Copyright and fix code blocks appearance
PSchmiedmayer
changed the title
Implement CI/Testing Setup and Update README Requirements♻️ Current Situation & ProblemThis PR addresses two open issues: Issue #5 : Lack of CI and testing setup leading to build-breaking changes. This PR aims to enhance our project's development workflow by introducing a CI/Testing setup. Additionally, it updates the README to reflect new requirements for contributions. A crucial aspect of this PR is to address a specific concern from a previous phase of our project - a commit ( ⚙️ Release Notes
Examples:
firebase emulators:exec --import=./sample_data "jupyter nbconvert --to pdf --execute SpeziDataPipelineTemplate.ipynb"
pip install pandas numpy matplotlib firebase-admin requests ipywidgets pytz📚 Documentation
📝 Code of Conduct & Contributing GuidelinesBy submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: I agree to follow the Code of Conduct and Contributing Guidelines. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implement CI/Testing Setup and Update README Requirements
♻️ Current situation & Problem
This PR aims to sign off a previous commit (7abc6a8) which was not signed at the time of submission. This is required for merging PR #8 .
⚙️ Release Notes
Signed off previous commit 7abc6a8.
📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: