Skip to content

Latest commit

 

History

History
73 lines (41 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

73 lines (41 loc) · 3.97 KB
Raw

Contributing to POWERBACK

We welcome contributions from the open-source community to help us improve POWERBACK and make it even more impactful. Whether you're a developer, designer, or someone passionate about the project, your contributions are valuable.

Before contributing, please take a moment to review these guidelines to ensure a smooth and collaborative process.

Table of Contents

Code of Conduct

Please note that by participating in this project, you are expected to adhere to the Code of Conduct. We have guidelines in place to ensure that the project's community is welcoming, respectful, and inclusive.

How Can I Contribute?

There are various ways you can contribute to POWERBACK:

Reporting Bugs

If you encounter a bug or issue while using POWERBACK, please open a new issue in our issue tracker. Be sure to include details about the problem, steps to reproduce it, and any relevant screenshots or error messages.

Suggesting Enhancements

If you have ideas for improving POWERBACK or adding new features, you can submit a feature request. Provide a clear description of the enhancement you're proposing, along with any relevant context or use cases.

Working on Issues

If you're interested in working on an existing issue, please check the issue tracker for open issues labeled as "help wanted" or "good first issue." Feel free to ask questions or seek clarification on any issue you'd like to tackle.

Submitting Pull Requests

To contribute code to POWERBACK, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Create a new branch from the beta branch with a descriptive name (e.g., feature/new-feature or fix/issue-123).

  3. Make your changes and ensure that your code adheres to any style guidelines.

  4. Write clear and comprehensive commit messages.

  5. Push your changes to your forked repository.

  6. Open a pull request (PR) from your branch to the beta branch of the POWERBACK repository.

  7. In your PR, provide a detailed description of the changes you've made and reference any related issues.

  8. Collaborate with reviewers to address feedback and ensure that your code is ready for merging.

  9. Once your PR is approved, it will be merged into the beta branch.

Development Setup

To set up a local development environment for POWERBACK, please refer to our Development Setup Guide. This guide provides detailed instructions on installing dependencies and configuring your environment. Be sure to see the Project Overview to learn about the app's structure, and the API Directory as a reference for how the front end communicates with the back end.

Style Guidelines

We promote following a set of coding and style guidelines to maintain consistency and readability in the codebase. Please join the discussion for deciding details on coding standards, formatting, and best practices!

License

By contributing to POWERBACK, you agree that your contributions will be licensed under the GPL License. Please read the LICENSE file for more information.

Thank you for considering contributing to POWERBACK! Your support helps make a difference in our mission to hold politicians accountable and empower individuals in the political process.