Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 2.12 KB

Contributing.md

File metadata and controls

45 lines (30 loc) · 2.12 KB
Raw

Contributing to PollPulse

Thank you for your interest in contributing to PollPulse! We appreciate your help in making this project better. Please take a moment to review this guide to understand how you can contribute.

Table of Contents

  1. How to Contribute
  2. Getting Started

How to Contribute

There are several ways you can contribute to this project:

Reporting Bugs

If you find a bug in the project, please help us by reporting it. To report a bug:

  1. Check if the issue has already been reported in the Issues section.
  2. If not, open a new issue with a clear and descriptive title.
  3. Provide detailed steps to reproduce the bug.
  4. Include any error messages or screenshots that can help us understand the issue better.

Suggesting Enhancements

We welcome suggestions for improvements or new features. To suggest an enhancement:

  1. Check if the enhancement idea has already been discussed in the Issues section.
  2. If not, open a new issue and describe the enhancement you have in mind. Be clear and specific about what you want to achieve.

Contributing Code

If you want to contribute code to this project, follow these steps:

  1. Fork this repository to your GitHub account.
  2. Create a new branch for your work: git checkout -b feature/your-feature-name.
  3. Make your changes and commit them with clear and concise messages.
  4. Push your changes to your forked repository: git push origin feature/your-feature-name.
  5. Open a pull request (PR) to the main repository's main branch. Provide a descriptive title and detailed description of your changes.
  6. Your PR will be reviewed, and any necessary feedback will be provided. Once approved, your changes will be merged.

Getting Started

To set up a development environment and run the project locally, refer to the instructions in the README.md file of this repository.