7aa55883e2
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Chores** - Refined repository settings to auto-exclude environment and build-related files. - Introduced a new configuration that streamlines local development and displays key tool versions on setup. - **Documentation** - Expanded contribution guidelines with a dedicated developer resources section linking to guides on development practices and repository structure. - Updated workflow instructions to better assist developers in setting up their environment, especially for those using Nix. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
3.8 KiB
Contributing to Unraid Connect
Thank you for your interest in contributing to Unraid Connect! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
TypeScript Import Extensions in the API Directory
When working with the API directory, you'll notice that TypeScript files are imported with .js extensions (e.g., import { something } from './file.js') even though the actual files have .ts extensions. This is because:
- We use ECMAScript modules (ESM) in our TypeScript configuration
- When TypeScript compiles
.tsfiles to.js, the import paths in the compiled code need to reference.jsfiles - TypeScript doesn't automatically change the extensions in import statements during compilation
- Using
.jsextensions in imports ensures that both TypeScript during development and Node.js in production can resolve the modules correctly
This approach follows the official TypeScript ESM recommendation and ensures compatibility across development and production environments.
Development Process
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
1. Work Intent Process
Before starting any development work, you must submit a Work Intent and have it approved:
-
Create a Work Intent
- Go to Issues → New Issue → Work Intent
- Fill out the brief template describing what you want to work on
- The issue will be automatically labeled as
work-intentandunapproved
-
Wait for Approval
- A core developer will review your Work Intent
- They may ask questions or suggest changes
- Once approved, the
unapprovedlabel will be removed
-
Begin Development
- Only start coding after your Work Intent is approved
- Follow the approach outlined in your approved Work Intent
- Reference the Work Intent in your future PR
2. Making Changes
- Fork the repo and create your branch from
main - Make your changes
- Ensure your commits are clear and descriptive
- Keep your changes focused - solve one thing at a time
3. Pull Request Process
- Create a pull request from your fork to our
mainbranch - Reference the approved Work Intent in your PR description
- Ensure the PR description clearly describes the problem and solution
- Include screenshots or examples if applicable
- Wait for review from the core team
Note: Direct pushes to the main branch are not allowed. All changes must go through the PR process.
Developer Documentation
For detailed information about development workflows, repository organization, and other technical details, please refer to our developer documentation:
- Development Guide - Setup, building, and debugging instructions
- Development Workflows - Detailed workflows for local development, building, and deployment
- Repository Organization - High-level architecture and project structure
Bug Reports and Feature Requests
We use GitHub issues to track bugs and feature requests:
- Bug Report: Use the Bug Report Template
- Feature Request: Use the Feature Request Template
For Unraid Connect specific issues (Flash Backup, connect.myunraid.net, mothership connectivity), please submit through our support portal instead.
License
By contributing, you agree that your contributions will be licensed under the same terms as the main project.