Skip to content

Commit 9861d30

Browse files
feat: inertial orbit rendering, telemetry hook, documentation
1 parent 5d1a80f commit 9861d30

19 files changed

Lines changed: 2244 additions & 430 deletions

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,6 @@ yarn-error.log*
4141
# typescript
4242
*.tsbuildinfo
4343
next-env.d.ts
44+
45+
# Antigravity agent files
46+
.agent/

CONTRIBUTING.md

Lines changed: 51 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,72 +4,73 @@ Thank you for your interest in contributing to OrbitView! 🛰️
44

55
## Getting Started
66

7-
1. **Fork the repository** ([OrbitVieW](https://github.com/SpaceEngineerSS/OrbitVieW)) and clone it locally
8-
2. **Install dependencies**: `npm install`
9-
3. **Start development server**: `npm run dev`
10-
4. **Create a branch**: `git checkout -b feature/your-feature-name`
7+
1. Fork the repository
8+
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/OrbitView.git`
9+
3. Create a feature branch: `git checkout -b feature/your-feature-name`
10+
4. Make your changes
11+
5. Submit a Pull Request
1112

12-
## Development Guidelines
13+
## Development Setup
1314

14-
### Code Style
15+
```bash
16+
# Install dependencies
17+
npm install
1518

16-
- Use TypeScript for all new code
17-
- Follow the existing code patterns
18-
- Use meaningful variable and function names
19-
- Add JSDoc comments for complex functions
19+
# Start development server
20+
npm run dev
2021

21-
### Commit Messages
22+
# Run tests
23+
npm test
2224

23-
Follow conventional commits format:
24-
- `feat:` New feature
25-
- `fix:` Bug fix
26-
- `docs:` Documentation changes
27-
- `style:` Code style changes (formatting, etc.)
28-
- `refactor:` Code refactoring
29-
- `test:` Adding or updating tests
30-
- `chore:` Maintenance tasks
25+
# Type checking
26+
npm run type-check
27+
```
3128

32-
Example: `feat: add observer location selector`
29+
## Before Submitting a Pull Request
3330

34-
### Pull Request Process
31+
> ⚠️ **Important:** Please ensure ALL tests pass before opening a PR.
3532
36-
1. Ensure your code passes linting: `npm run lint`
37-
2. Update documentation if needed
38-
3. Add tests for new features
39-
4. Create a clear PR description explaining the changes
40-
5. Link any related issues
33+
```bash
34+
# Run the full test suite
35+
npm test
4136

42-
## Project Structure
37+
# Verify type safety
38+
npm run type-check
4339

44-
```
45-
src/
46-
├── app/ # Next.js pages
47-
├── components/ # React components
48-
│ ├── HUD/ # User interface panels
49-
│ └── Scientific/ # Analysis tools
50-
├── lib/ # Core calculations
51-
├── hooks/ # Custom React hooks
52-
└── types/ # TypeScript definitions
40+
# Build check
41+
npm run build
5342
```
5443

55-
## Reporting Bugs
44+
## Code Style Guidelines
5645

57-
When reporting bugs, please include:
58-
- Steps to reproduce
59-
- Expected behavior
60-
- Actual behavior
61-
- Browser/OS information
62-
- Screenshots if applicable
46+
- Use TypeScript for all new code
47+
- Follow existing code patterns and naming conventions
48+
- Add JSDoc comments for public functions
49+
- Keep components focused and reusable
50+
51+
## Commit Messages
6352

64-
## Feature Requests
53+
Use clear, descriptive commit messages:
6554

66-
We welcome feature suggestions! Please open an issue with:
67-
- Clear description of the feature
68-
- Use case / why it would be useful
69-
- Any implementation ideas
55+
- `feat: add doppler shift visualization`
56+
- `fix: correct orbit path rendering for GEO satellites`
57+
- `docs: update README with new features`
58+
- `refactor: optimize worker batch processing`
59+
60+
## Reporting Issues
61+
62+
When reporting bugs, please include:
63+
64+
1. Browser and version
65+
2. Steps to reproduce
66+
3. Expected behavior
67+
4. Actual behavior
68+
5. Console errors (if any)
7069

7170
## Questions?
7271

73-
Feel free to open a discussion or issue if you have questions.
72+
Feel free to open an issue for any questions or suggestions!
73+
74+
---
7475

75-
Thank you for contributing! 🚀
76+
Thank you for helping make OrbitView better! 🚀

0 commit comments

Comments
 (0)