Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (79 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

116 lines (79 loc) · 2.41 KB

Contributing to SimToFly

Thank you for your interest in contributing! 🎉

How You Can Help

1. Report Issues

Found a typo, broken command, or unclear explanation? Open an issue

Good issue includes:

  • Which tutorial section (e.g., "Phase 1, Section 1.3")
  • What went wrong
  • Your system info (Ubuntu version, hardware)
  • Error messages (full text or screenshot)

2. Suggest Improvements

Have an idea to make tutorials clearer? Open an issue with "Enhancement" label

3. Fix Typos or Errors

Small fixes are welcome!

  1. Fork this repository
  2. Make your changes
  3. Submit a pull request

For small fixes: No need to open issue first, just send PR.

4. Add Content

Want to contribute a full tutorial section?

Please open an issue first to discuss:

  • What section you want to add
  • How it fits into existing structure
  • Ensure no duplicate effort

Writing Guidelines

If contributing tutorial content:

Style

  • Beginner-friendly — Assume zero prior knowledge
  • Clear explanations — Explain why, not just how
  • Verify steps — Every section needs verification
  • Include troubleshooting — Common errors and solutions

Format

  • Use Markdown
  • Add verification checkboxes: - [ ]
  • Include expected outputs
  • Show complete error messages
  • Link between related sections

Code Blocks

# Use comments to explain
command --with-flags

# Show expected output
# Output: Success message here

Testing

Before submitting tutorial content:

  • Test every command on fresh Ubuntu 22.04
  • Verify all links work
  • Check images load correctly
  • Confirm troubleshooting steps work

Pull Request Process

  1. Fork the repository
  2. Create a branch: git checkout -b fix-section-1-3
  3. Make changes
  4. Test thoroughly
  5. Commit: git commit -m "Fix typo in 1.3-ardupilot-sitl.md"
  6. Push: git push origin fix-section-1-3
  7. Open Pull Request with clear description

Code of Conduct

  • Be respectful and constructive
  • Help beginners learn
  • Assume good intentions
  • Focus on making tutorials better

Questions?

Not sure if your contribution fits? Just ask!

Open an issue and we'll discuss. No contribution is too small.

Thank you for helping make SimToFly better! 🚁