Skip to content

Conversation

@daniellacosse
Copy link
Collaborator

@daniellacosse daniellacosse commented Jul 14, 2025

This pull request introduces several improvements, including new GitHub issue templates, updated documentation, automated quality checks, and the addition of license headers to multiple files. These changes aim to streamline issue reporting, enhance build instructions, ensure code quality, and comply with licensing requirements.

GitHub Issue Templates and Configuration:

  • Added a new bug report template (.github/ISSUE_TEMPLATE/bug_report.yml) to guide users in reporting issues, including steps to reproduce and environment details.
  • Added a feature request template (.github/ISSUE_TEMPLATE/feature_request.yml) to help users propose new features with detailed descriptions and use cases.
  • Updated the GitHub issue configuration to include a contact link for the community's Reddit page (.github/ISSUE_TEMPLATE/config.yml).

Documentation Updates:

  • Revised README.md to swap the iOS and Android build instructions, providing updated dependencies and clearer steps for building Android and iOS apps. [1] [2] [3]
  • Removed the "commonly occurring issues" section from README.md, which was previously marked as a TODO.

Automation and Quality Checks:

  • Introduced a new GitHub Actions workflow (.github/workflows/quality_checks.yml) to automate quality checks, including Android and iOS builds and license header validation.
  • Added a .vscode/settings.json file to associate the YAML schema for GitHub issue configuration with the corresponding file.

Licensing Compliance:

  • Added Apache 2.0 license headers to various source files and templates across the project, ensuring compliance with licensing requirements. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Note

Punting lint to a separate PR. GTS lints TS files with no way to properly configure it for MJS files: google/gts#655
We likely want to remove go and convert the existing files to TS before adding the Google-standard GTS linter.

Closes #5

@daniellacosse daniellacosse force-pushed the daniellacosse/github_configuration branch 2 times, most recently from 81650da to e5f8d7e Compare July 14, 2025 20:51
@daniellacosse daniellacosse marked this pull request as ready for review July 14, 2025 20:54
@daniellacosse daniellacosse requested a review from fortuna July 14, 2025 20:54
fortuna
fortuna previously approved these changes Jul 14, 2025
@daniellacosse daniellacosse requested a review from fortuna July 16, 2025 18:52
Copy link
Contributor

@jyyi1 jyyi1 left a comment

Choose a reason for hiding this comment

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

Thanks! This will be useful!

Copy link
Contributor

@jyyi1 jyyi1 left a comment

Choose a reason for hiding this comment

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

Thanks. LGTM.

@daniellacosse daniellacosse enabled auto-merge (squash) July 29, 2025 16:41
@daniellacosse daniellacosse merged commit 7148f5e into main Jul 29, 2025
6 checks passed
@daniellacosse daniellacosse deleted the daniellacosse/github_configuration branch July 29, 2025 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CI Build Test

4 participants