Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial setup #2

Closed
wants to merge 49 commits into from
Closed

Initial setup #2

wants to merge 49 commits into from

Conversation

eldcn
Copy link
Contributor

@eldcn eldcn commented May 7, 2024

Inital Setup

♻️ Current situation & Problem

Link any open issues or pull requests (PRs) related to this PR. Please ensure that all non-trivial PRs are first tracked and discussed in an existing GitHub issue or discussion.

⚙️ Release Notes

  • Added Core Design: The Design System Module is part of the SpeziKt framework, designed to provide a cohesive user interface and user experience components. It ensures consistent aesthetics and functionality across different parts of the application, enhancing both developer efficiency and user satisfaction.
  • Added Build-logic: The build-logic folder contains SpeziKt specific convention plugins that are used for common module configurations.
  • Added Contact Module: This module provides a simple screen to display contact information.

📚 Documentation

Module Convention Plugin
Module Design
Module contact

✅ Testing

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Basler182 & @eldcn, thank you for the great PR and first foundation. I had a few very high-level comments and I am excited about the next steps.

Great job with the foundation @Basler182 and thank you for your input and improvements @eldcn!

It would be great if we can adjust the PR description to reflect the changes here in this PR 👍

Comment on lines +6 to +7
pull_request:
branches: [ "main" ]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might make sense to enable this for all PRs and add a workflow dispatch in case you want to manually tigger it.

Suggested change
pull_request:
branches: [ "main" ]
pull_request:
workflow_dispatch:

In the long run, we might want to move this into a reusable GitHub action in the .github repo as we did for some of the other actions.

@@ -0,0 +1,102 @@
name: Android CI
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great if we can include the setup to include a codecov reporting, REUSE specification, and markdown link checker here as well.

Sort of like we do for our Swift counterpart: https://github.com/StanfordSpezi/Spezi/blob/main/.github/workflows/pull_request.yml

I have added a CODECOV_TOKEN in the GitHub Actions secrets for this repo to be used.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if we want to provide something like the contact repository in our main API surface and to see if we can synchronize this a bit more with the IOS SDK. Not required to be changed in this PR but maybe something to look into.

CC @pauljohanneskraft

@PSchmiedmayer PSchmiedmayer added the enhancement New feature or request label May 9, 2024
@PSchmiedmayer PSchmiedmayer mentioned this pull request May 9, 2024
1 task
@Basler182 Basler182 closed this May 20, 2024
@Basler182 Basler182 deleted the feature/initial-setup branch June 13, 2024 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants