Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

81 lines (59 loc) · 2.46 KB
Raw

Contributing to Balanz.io

Thank you for your interest in contributing to Balanz.io! We welcome all types of contributions, whether it's bug fixes, feature improvements, documentation updates, or any other suggestions.

Table of Contents

  1. How to Contribute
  2. Code of Conduct
  3. Submitting Issues
  4. Creating Pull Requests
  5. Coding Guidelines
  6. Commit Messages
  7. Development Setup

How to Contribute

  1. Fork the repository.
  2. Clone your fork to your local machine: 
    git clone https://github.com/rajveeerr/Balanz.io.git
  3. Create a new branch for your feature or bugfix: 
    git checkout -b feature/your-feature-name
  4. Make your changes and ensure that everything works as expected.
  5. Push the changes to your fork and create a pull request (PR) to the main repository.

Code of Conduct

Please ensure a positive experience for all contributors.

Submitting Issues

If you find any bugs or have feature requests, feel free to open an issue. When submitting an issue, please provide as much information as possible, including:

  • Steps to reproduce the problem
  • Browser/OS used
  • Expected and actual results

Creating Pull Requests

When submitting a pull request:

  1. Ensure that your code passes all tests.
  2. Use descriptive commit messages.
  3. Include a detailed description of what the PR does and reference related issues if applicable.

Coding Guidelines

  • Follow the existing code style (formatting, naming conventions, etc.).
  • Ensure your changes are properly documented.
  • Test your changes before submitting a PR.

Commit Messages

  • Keep the messages concise yet descriptive.
  • If the commit addresses an issue, include the issue number (e.g., Fix #123 - Adjust task sync logic).

Development Setup

  1. Clone the repository:

    git clone https://github.com/rajveeerr/Balanz.io.git
cd Balanz.io

  2. Install dependencies:

    npm install

  3. Run the app:

    npm start

  4. Make changes and run tests: Ensure your changes work by testing the app thoroughly.

Thank You

Thank you for your contributions! Balanz.io aims to provide a smooth, user-friendly task management experience, and your support helps make it better. Feel free to reach out if you have any questions or need help contributing.