Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (82 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

107 lines (82 loc) · 3.48 KB

Contributing to FlowPay

We welcome contributions to FlowPay and appreciate the effort made by every contributor. If you're interested in improving the project, here's how you can get involved:

Table of Contents

How to Contribute

Fork the Repository

  1. Fork the repository by clicking the "Fork" button on the FlowPay GitHub page.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/<your-username>/Flowpay.git
cd Flowpay

Set Up Your Development Environment

  1. Install dependencies: 
    npm install
  2. Set up environment variables by copying the .env.example file to .env and filling in the necessary details (e.g., JWT_SECRET, NEXTAUTH_URL, DATABASE_URL).
  3. Initialize the database: 
    npm run db:migrate
npm run db:generate
  4. Start the development server: 
    npm run dev

Create a New Branch

  1. Create a new branch to work on your feature or fix: 
    git checkout -b feature/your-feature-name

Make Changes

  • Write your code and make sure it adheres to the coding standards of this project.
  • Test your changes locally and ensure everything works as expected.

Commit and Push Changes

  1. Add your changes: 
    git add .
  2. Commit your changes with a clear and descriptive message: 
    git commit -m "Add your commit message here"
  3. Push your changes: 
    git push origin feature/your-feature-name

Open a Pull Request

  • Open a pull request to the main branch of this repository. Provide a clear description of the changes you’ve made and any additional information.

Contributing Guidelines

Code Standards

  • Follow best practices for writing clean, readable, and maintainable code.
  • Use ESLint and Prettier to ensure consistent code formatting. Check if the project’s .eslint.json and .prettierrc configurations are in place.

Commit Messages

Testing

  • Make sure you write tests for any new features or bug fixes.
  • Ensure all existing tests pass by running: 
    npm run test

Pull Request Reviews

  • Be open to feedback and make requested changes before merging your pull request.

Suggested Contributions

We appreciate contributions in the following areas:

  • Bug Fixes: Help fix any issues found in the project. Check the open issues for details.
  • Features: Add new features to enhance the functionality of FlowPay.
    • For example, a merchant app or integration with additional payment providers.
    • Webhooks for event-driven actions.
  • UI/UX Enhancements: Improve the user interface, accessibility, and design.
  • Documentation: Help improve the documentation by fixing typos, improving readability, or adding missing information.

Code of Conduct

Please be respectful and follow the Code of Conduct while contributing to this project.

Thank you for contributing to FlowPay! Your help is truly appreciated! 🚀