docs: Add foundational documentation

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,45 @@
+This template outlines the recommended format for creating pull requests within this project. Please fill out all sections before submitting your PR
+
+## Branch Naming:
+
+- Use a descriptive branch name that reflects the change and follows the format: [type]/[brief-description]
+- Replace [type] with feature, fix, refactor, hotfix, or other relevant categories
+- Keep the description concise and clear
+
+## Commit Guidelines:
+
+- Adhere to the "scope:subject" commit message structure
+- Scope can be feat, fix, docs, test, refactor, build, format, etc.
+- Use imperative tense (e.g., "fix: User unable to login")
+## Pull Request Checklist:
+
+[ ] **Read the contributing guidelines** <br />
+[ ] **Branch is up-to-date with the base branch: main (or other designated branch)**<br />
+[ ] **Changes pass all tests: npm test or yarn test (or equivalent command)**<br />
+[ ] **Documentation has been updated (if applicable)**<br />
+## Description:
+- Start your pull request summary with a clear and informative heading. Use the Markdown syntax `##` for the heading, like `## Your Heading Here`.
+- For the section detailing the changes introduced by this pull request, use the Markdown heading `## Changes`. 
+- Briefly describe the changes introduced in this pull request.Ensure that the changelog has been updated accordingly
+- Explain the motivation and the problem it solves
+- Mention any breaking changes
+- Link to related issues or internal tickets
+## Additional Notes:
+
+- Include any other relevant information, such as limitations, known issues, or future improvements.
+## Screenshots (if applicable):
+
+- Add screenshots or GIFs to help visualize your changes.
+## Testing Instructions:
+
+- Provide step-by-step instructions on how to test your changes 
+## Checklist for Reviewers:
+
+[ ] **Code follows project conventions and style guidelines**<br />
+[ ] **Changes do not introduce new warnings or errors**<br />
+[ ] **Unit tests cover the changes adequately**<br />
+[ ] **Documentation is updated correctly and reflects the changes**<br />
+Additional Information:
+
+By submitting this pull request, I confirm that my contribution is made under the terms of the MIT License.
+

.github/workflows/test-and-build.yml

@@ -0,0 +1,48 @@
+name: test-and-build
+
+env:
+  # The name of the main module repository
+  main_project_module: app
+
+on:
+
+  pull_request:
+    branches: [master, develop]
+
+  # # Allows you to run this workflow manually from the Actions tab
+  # workflow_dispatch:
+
+jobs:
+  test-and-build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+
+      - name: Set Up JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'zulu' # See 'Supported distributions' for available options
+          java-version: '17'
+          cache: 'gradle'
+
+      - name: Change wrapper permissions
+        run: chmod +x ./gradlew
+
+      # Run ktlint checks
+      - name: Run ktlint checks
+        run: ./gradlew ktlintCheck
+
+      # Run Build Project
+      - name: Build gradle project
+        run: ./gradlew build
+
+      # Create Bundle AAB Release
+      # Noted for main module build [main_project_module]:bundleRelease
+      - name: Build app bundle release
+        run: ./gradlew ${{ env.main_project_module }}:bundleRelease

CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+### Added
+
+- New feature or enhancement.
+
+### Changed
+
+- Updates to existing features.
+
+### Deprecated
+
+- Features or functionalities to be removed in future releases.
+
+### Removed
+
+- Features or functionalities that have been removed.
+
+### Fixed
+
+- Bug fixes.
+
+### Security
+
+- Security-related changes.
+
+## [Version] - YYYY-MM-DD
+
+### Added
+
+- New feature or enhancement.
+
+### Changed
+
+- Updates to existing features.
+
+### Deprecated
+
+- Features or functionalities to be removed in future releases.
+
+### Removed
+
+- Features or functionalities that have been removed.
+
+### Fixed
+
+- Bug fixes.
+
+### Security
+
+- Security-related changes
+

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before working on a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Guidelines
+
+1. Please ensure your proposal will not radically change current functionality or bring along breaking changes.
+2. PRs only consisting of typo fixes (or other automated contributions), will not be accepted.
+4. Document your changes thoroughly.
+6. Be reactive to any comments, reviews or change requests entered in your pull request.