Skip to content

Latest commit

 

History

History
153 lines (113 loc) · 5.59 KB

CONTRIBUTING.md

File metadata and controls

153 lines (113 loc) · 5.59 KB

🤝 Contributing to SafeHaven

Thank you for your interest in contributing to 🛡️ SafeHaven : A Crowdsourced Disaster Management Platform.
This guide will help you get started smoothly, whether you're contributing to code, design, or content.

📚 Quick Navigation

🌐 Step 1: Explore Before You Contribute

Before contributing, please:

  • Read the README to understand the project.
  • Explore the deployed website to get a sense of its structure and features.
  • Review open issues and issue templates to find where you can contribute.

💻 Step 2: Project Setup

On your local system :

  1. Clone the repository
git clone https://github.com/archangel2006/SafeHaven.git
  1. Go to the current directory
cd SafeHaven
  1. Run the main page
Run index.html locally in your browser

🧩 Step 3a: Ways to Contribute

You can contribute to this project in these main ways:

  1. Code Contributions - Fix bugs, add new features, improve components, add content, or optimize existing functionality.

  2. Design Contributions - Suggest UI/UX improvements, create Figma mockups, design icons/logos, or propose layout revamps.

  3. 🧹 Maintenance Contributions - Clean up files, extract assets from links, separate inline CSS/JS, or improve documentation and structure.

🧭 Step 3b: How to Contribute

  1. Star ⭐ and Fork 🍴 this repository.

  2. Code Contributions:

  3. Design Contributions:

    • Include Figma or screen design images and links in your PR. You may upload screenshots, Figma links, or UI/UX previews.
    • Place files in the designated design folders or relevant .md sections.

  4. Maintenance Contributions:

    • Address issues like:
      • Extracting embedded images or assets and adding them to /assets/.
      • Moving CSS/JS into separate files.
      • Updating README or file structure consistency.
    • Submit your PR under the “maintenance” label.

🧩 Code & Design Rules

Please follow these basic standards to maintain quality and readability:

  • Use meaningful variable and file names
  • Keep consistent indentation
  • Add relevant comments only
  • Avoid inline CSS/JS
  • Follow Semantic HTML (use proper tags like , , , )
  • Reuse components when possible
  • Keep UI clean, minimal, and responsive

🪶 Branch & Commit Conventions

Type Branch Prefix Commit Prefix Description
New Feature feature/ feat: Adding new functionality or pages
Bug Fix fix/ fix: Resolving issues or broken behavior
Maintenance chore/ chore: Config updates, repo organization
Documentation docs/ docs: Updating docs, README, or guides
UI/UX & Design uiux/ design: Design mockups, page revamps, visual tweaks
Resources resources/ resource: Adding educational content/resources
Refactor refactor/ refactor: Code improvement without feature change
Style style/ style: CSS fixes, spacing, or formatting changes

Example:

# Branch
uiux/community-redesign

# Commit
design: revamp Community page layout for better clarity

🧾 Issue & Pull Request Rules

  1. Browse through existing issues before creating new ones.
  2. Get assigned to an issue before starting work.
  3. No duplicate or spam issues.
  4. If no PR or update is made within 5 days of assignment, it may be reassigned.
  5. Major issues may have sub-issues — feel free to request one if you want to contribute to a smaller part.
  6. Always mention issue number in your PR description (e.g., “Fixes #12”).

📜 Code of Conduct

Please note that this project is governed by a Code of Conduct.
By participating, you are expected to uphold a respectful, inclusive, and positive environment for everyone.
Be kind, constructive, and professional in all discussions and contributions.

🙌 Acknowledgements

We deeply appreciate every contributor who helps make SafeHaven better.
Whether it’s fixing a small bug, improving design, or refining documentation — your efforts matter.

Special thanks to:

  • Project Maintainers – for guidance and reviews
  • Design & Code Contributors – for creativity and effort
  • Community Members – for feedback, testing, and support

Your contribution helps build a safer, more connected digital space 🌍

Made with ❤️ by the SafeHaven Community