Merge pull request #54 from WhyAsh5114/repo-guidelines

Repo guidelines and community standards

.github/CONTIBUTING.md

@@ -0,0 +1,88 @@
+# Contributing to MyFit
+
+We welcome contributions to MyFit! Whether it's reporting an issue, improving documentation, adding new features, or fixing bugs, your help is greatly appreciated. Please follow the guidelines below to ensure a smooth contribution process.
+
+## Getting Started
+
+### Prerequisites
+
+Make sure you have the following tools installed:
+
+- **Node.js** (v20.16.0 or higher)
+- **npm**
+- **TypeScript**
+- **Docker** (if applicable, for local CockroachDB setup)
+
+### Setup Instructions
+
+1. Fork the repository.
+2. Clone your forked repository:
+   ```bash
+   git clone https://github.com/WhyAsh5114/MyFit.git
+   cd MyFit
+   ```
+3. Install dependencies:
+   ```bash
+   npm install
+   ```
+4. Set up your environment variables. Copy `.env.example` to `.env` and configure the necessary values.
+
+5. Start the development server:
+   ```bash
+   npm run dev
+   ```
+
+### Code Structure
+
+- **Frontend**: The app is built with SvelteKit
+- **Backend**: API calls are handled using tRPC
+- **Database**: Prisma with CockroachDB as the provider
+- **Testing**: Playwright is used for end-to-end testing
+
+## How to Contribute
+
+### Reporting Issues
+
+If you find a bug or have a feature request, please check the [existing issues](https://github.com/WhyAsh5114/MyFit/issues) first. If your issue is not listed, create a new one and provide as much detail as possible.
+
+### Proposing Changes
+
+1. Create a new branch for your changes:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+2. Make your changes, and ensure the code is properly formatted and linted
+3. Write tests if necessary
+4. Commit your changes with a meaningful commit message:
+   ```bash
+   git commit -m "Add feature: your-feature-name"
+   ```
+5. Push your changes to your forked repository:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+6. Open a pull request (PR) to the main repository. Make sure to describe your changes clearly in the PR description
+
+### Code Guidelines
+
+- **TypeScript**: Let TypeScript infer return types wherever possible
+- **Testing**: Ensure all tests pass before opening a PR
+- **Documentation**: Update documentation when changes affect significant functionality
+
+### Testing
+
+Run the tests to ensure your changes don't break anything:
+
+```bash
+npm run test
+```
+
+We use Playwright for end-to-end testing, so make sure to write tests covering new features or bug fixes.
+
+## Code Reviews
+
+All PRs will be reviewed by project maintainers. We may request changes or provide feedback to ensure the code aligns with the project's standards.
+
+### Thank You
+
+Thank you for taking the time to contribute to MyFit! Your efforts help make this project better for everyone.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,39 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Also, list any relevant details for your test configuration.
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+
+- Firmware version:
+- Hardware:
+- Toolchain:
+- SDK:
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules

.github/SECURITY.md

@@ -0,0 +1,41 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 3.x.x   | :white_check_mark: |
+| 2.0.x   | :white_check_mark: |
+| 1.0.x   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in our Node.js web application or CockroachDB backend, please follow the guidelines below:
+
+### How to Report
+
+1. **Email**: Send an email to `myfit.auth@gmail.com` with the details of the vulnerability.
+
+   - Use the subject line: `Security Vulnerability Report - [Your Issue Title]`.
+   - Provide a detailed description of the vulnerability, including:
+     - Affected components (e.g., frontend, API, database).
+     - Steps to reproduce the issue.
+     - Potential impact on the application and its users.
+     - Any suggested fixes or mitigations.
+
+2. **Response Time**:
+
+   - You can expect an initial response within **72 hours** of your report.
+   - We will provide regular updates as we investigate and work on a fix, typically every **5-7 business days**.
+
+3. **After Reporting**:
+
+   - If the vulnerability is confirmed, we will work on a patch or mitigation strategy.
+   - You will be credited for your discovery unless you wish to remain anonymous.
+   - We will coordinate with you on the responsible disclosure of the vulnerability and its fix.
+
+4. **Non-Disclosure**: Please do not disclose the vulnerability publicly until it has been addressed. We take security seriously and will work to resolve all reported issues as quickly as possible.
+
+5. **Bug Bounties**: While we currently do not have a formal bug bounty program in place, we highly value and appreciate the efforts of security researchers who help us identify vulnerabilities. At this time, we are unable to offer monetary rewards. However, we are committed to acknowledging your contributions and, where appropriate, can provide public recognition for your efforts.
+
+Thank you for helping us keep our app secure!

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+myfit.auth@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.