Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 3.41 KB

Contributing.md

File metadata and controls

57 lines (42 loc) · 3.41 KB
Raw

Contributing to CanSat

Welcome to the CanSat project! This app provides a platform to visualize and track CanSat (Can-sized satellite) projects, particularly in connection with Liquid Galaxy systems. Whether you are passionate about satellite projects, interactive maps, or Liquid Galaxy systems, your contributions are valuable in enhancing this platform.

How to Contribute

We welcome contributions of all kinds, including bug fixes, feature enhancements, documentation improvements, and more! Here's how you can get started:

  1. Fork the Repository: Start by forking the repository.
  2. Clone the Repository: Clone your fork to your local machine: 
    git clone https://github.com/YOUR-USERNAME/CanSat.git
  3. Create a Branch: Create a new branch for your changes: 
    git checkout -b feature-or-bugfix-branch
  4. Make Changes: Implement your changes, following best coding practices.
  5. Test Your Changes: Ensure your code works as expected by running any necessary tests or scripts.
  6. Commit Your Changes: Make clear and concise commit messages: 
    git commit -m "Description of changes"
  7. Push to Your Fork: Push the changes to your forked repository: 
    git push origin feature-or-bugfix-branch
  8. Submit a Pull Request (PR): Open a PR from your fork to the main repository. You can refer to pull request template before creating a PR.

Guidelines

  • Documentation: Clearly document new features or changes. Update the README file if necessary.
  • Coding Standards: Follow clean coding principles, and ensure your code is well-commented and easy to understand.
  • Code Reviews: All submissions will undergo code review before merging. Be open to suggestions and improvements from the project maintainers.
  • Respect the Project's Architecture: If you're proposing new features or architecture changes, please provide detailed justifications in your PR.

Code of Conduct

We expect all contributors to adhere to the Code of Conduct. Please maintain a respectful and professional attitude when collaborating with others.

Bug Reports, Feature Requests and Documentation requests

  • Bugs: If you encounter any bugs, please submit an issue with detailed steps to reproduce the problem. You can refer to bug report for a sample template.
  • Feature Requests: Have ideas for improvements? Open an issue and describe your suggestion. You can refer to feature request for a sample template.
  • Documentation Requests: If you find areas in the documentation that need improvement, please submit an issue with details. You can refer to the documentation request for a sample template.

Contributors ❤️

A huge thanks to all our contributors for your support and dedication to this project!🌟

This structure should help guide new contributors effectively, outlining the steps and guidelines clearly.