Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 2.99 KB
Raw

Contribution Guide for Hazard Response Mission Pack

Thank you for your interest in contributing to our Hazard Response Mission Pack project! We welcome contributions from the community to help build and enhance our project. Here’s how you can get involved and contribute effectively.

Repository Structure

For Node-RED flows, please place them in the node-red-flows directory at the root of the repository. This directory is organized into three categories:

  • snippets: Small, reusable pieces of functionality.
  • projects: Complete, standalone projects.
  • functional-nodes: Specific Node-RED nodes with defined functionality.

Types of Contributions

We welcome contributions of any kind, including but not limited to:

  • Node-RED Flows: As described above.
  • Documentation: Improvements, corrections, and additions to the documentation.
  • System Enhancements: Updates or changes to the system architecture or configurations.
  • Software: New features, bug fixes, or improvements to the existing software.
  • Firmware: Contributions to the firmware that interacts with our hardware.

Getting Started

  1. Fork the Repository: Start by forking the repository to your GitHub account.
  2. Clone Your Fork: Clone your fork to your local machine using: 
    git clone https://github.com/<your-username>/Hazard-Response-Mission-Pack.git
  3. Create a Branch: Create a new branch for your changes: 
    git checkout -b my-new-feature

Making Changes

  1. Add Your Contribution: Add your files or make changes to the existing files in the appropriate directories.
  2. Follow Existing Formats: Ensure that your contributions follow the format and style of the existing content in the repository.
  3. Test Your Changes: Test your changes thoroughly to ensure they work as expected and do not introduce any issues.

Submitting Your Contribution

  1. Commit Your Changes: Commit your changes with a clear and descriptive message: 
    git add .
git commit -m "Add new feature/update for X"
  2. Push to Your Fork: Push your changes to your forked repository: 
    git push origin my-new-feature
  3. Create a Pull Request: Go to the original repository on GitHub and create a new pull request. Provide a clear description of your changes and reference any relevant issues.

Review Process

Once you have submitted your pull request (PR), it will be reviewed by the repository maintainers. They may suggest changes or improvements. Please be responsive to feedback and make the necessary updates.

Questions

If you have any questions or need further assistance, feel free to open an issue in the repository or reach out to the maintainers.

We look forward to your contributions and thank you for helping us improve the Hazard Response Mission Pack!

Feel free to customize this guide further based on the specific needs and structure of your project.