Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 5.03 KB

README.md

File metadata and controls

90 lines (62 loc) · 5.03 KB
Raw

MassEnergize Logo

MassEnergize API

This repo contains the code for the massenergize API that powers all the massenergize websites and mobile apps.

Report Bug · Request Feature · FAQ · Ask Question

Welcome to MassEnergize's API!

🌍 MassEnergize is on a mission to tackle the climate emergency head-on! We work with community organizers and local leaders to supercharge household and community-level climate actions. Our open-source API is a crucial part of this mission, and we need YOU to join our team of eco-warriors!

The Situation: Mother Earth's throwing some serious shade our way (literally, with all this heat). We need a code-powered climate crusade!

The Backend Team's Mission: We're like climate action superheroes, except instead of capes, we rock awesome APIs! We empower everyday people to fight climate change with household-level solutions. Why? Because a million tiny changes add up to a HUGE impact

Table of Contents

Why Contribute?

  • Fight Climate Change: Use your coding skills to help save the planet. How cool is that?
  • Empower Communities: Your contributions will directly help communities adopt climate-friendly practices.
  • Be a Hero: Gain recognition and respect in the tech and environmental communities.

How to Contribute

Ready to make a difference? Follow these simple steps to join our cause:

  1. Fork the Repository: Click the 'Fork' button at the top of this page to create your own copy of this repository. Fork it like a pro!
  2. Clone the Repository: Use git clone to bring the repository to your local machine. It’s like bringing the fight against climate change to your backyard.
  3. Create a New Branch: Create a new branch with git checkout -b your-branch-name. Fun branch names encouraged!
  4. Make Your Changes: Add features, fix bugs, write tests, and update documentation. Channel your inner eco-warrior.
  5. Commit Your Changes: Use meaningful and fun commit messages. “Fixed bug” is good; “Squashed the carbon bug” is better.
  6. Push to GitHub: Push your changes to your forked repository. Ready, set, push!
  7. Create a Pull Request: Submit a pull request to the main branch of this repository. Tell us about your changes and link any relevant issues.

Contribution Guidelines

To keep our mission on track, please follow these guidelines:

Do's

  • Write Clean, Green Code: Follow our coding standards to keep your code efficient and effective.
  • Document Thoroughly: Make sure your code is well-documented with clear comments and README updates.
  • Test Your Code: All new features and bug fixes should include tests. Quality is key!
  • Be Respectful: Engage with other contributors kindly. We’re all in this together!
  • Review Open PRs: If you have the time, review open pull requests and provide constructive feedback. Every little bit helps!

Don'ts

  • Submit Unfinished Work: Ensure your code is complete and tested before submitting a pull request.
  • Ignore Guidelines: Stick to the project’s coding standards and contribution guidelines to ensure consistency.
  • Be a Naysayer: Maintain a positive and supportive environment. Negativity won’t save the planet!

Get in Touch

Need help or just want to chat with fellow eco-warriors? Here’s how you can reach us:

  • GitHub Issues: Open an issue for questions, bugs, or suggestions.
  • Email: Drop us a line at massenergize mail if you prefer traditional communication.

We’re excited to see your contributions and work together to create a greener, more resilient world! 🌱

Happy Coding and Keep it Green!

codecov