Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 2.17 KB

CONTRIBUTING.MD

File metadata and controls

66 lines (41 loc) · 2.17 KB

Contributing to PayBox

Welcome to PayBox! We're thrilled that you're interested in contributing. By participating in this project, you agree to abide by the Code of Conduct.

Getting Started

Before you start contributing, please make sure you have read and understood the README file to get an overview of the project and its goals.

Prerequisites

List any dependencies or tools that contributors need to have installed before they can start contributing.

Installing

Provide step-by-step instructions on how to set up the development environment.

# Example installation steps
git clone https://github.com/shawakash/payBox.git
cd payBox
yarn install
yarn build
cd backend/hasura
docker-compose up
cd ../api
yarn dev

Backend on http://localhost:8080.

How to Contribute

We welcome contributions from everyone! Here are some ways you can contribute:

Reporting Bugs

If you find a bug, please open an issue. Provide as much detail as possible, including your environment, steps to reproduce, and expected behavior.

Suggesting Enhancements

If you have an idea for an improvement, feel free to open an issue to discuss it. We value your input!

Code Contributions

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/new-feature or git checkout -b bug/fix-bug.
  3. Make your changes and commit them with a clear and concise message: git commit -m "Description of the changes.".
  4. Push your changes to your fork: git push origin feature/new-feature.
  5. Open a pull request, providing a detailed description of your changes.

Coding Standards

Follow the coding standards and style guide of the project. If there isn't one, maintain consistency with the existing code.

Tests

If applicable, write tests for your changes and ensure existing tests pass.

Code of Conduct

Please review and adhere to our Code of Conduct. It outlines the behavior expected from all contributors.

Licensing

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for your contribution! 🎉