Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 2.76 KB
Raw

Contributing to Mobile Payment Library

Thank you for considering contributing to the Mobile Payment Library! Your help is essential for improving and expanding this project.

Table of Contents

Getting Started

To get started with contributing, please ensure you have the following set up:

  1. Fork the repository: Click on the "Fork" button at the top right corner of the repository page.

  2. Clone your fork:

    git clone https://github.com/TheOddagen/Mobile-Payments-Library

  3. Add the original repository as a remote:

    git remote add upstream https://github.com/TheOddagen/Mobile-Payments-Library

  4. Install the necessary dependencies:

    ./gradlew build

How to Contribute

There are several ways you can contribute to the Mobile Payment Library:

  1. Reporting Bugs: If you encounter any bugs, please report them by opening an issue. Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots.

  2. Suggesting Enhancements: If you have any ideas for new features or improvements, please open an issue to discuss them.

  3. Writing Code: You can contribute by fixing bugs, adding new features, or improving existing code. Please follow the guidelines below to ensure a smooth contribution process.

Code Style

Please follow these guidelines to maintain code consistency:

  1. Java Code Style: Follow the Google Java Style Guide.

  2. Documentation: Ensure your code is well-documented. Use Javadoc for public methods and classes.

  3. Testing: Write tests for your code. We use JUnit for unit testing. Ensure that all tests pass before submitting your changes.

Submitting Changes

  1. Create a new branch:

    git checkout -b feature-name

  2. Make your changes and commit them:

    git commit -m "Description of your changes"

  3. Push your branch to your fork:

    git push origin feature-name

  4. Open a Pull Request: Go to the original repository and open a pull request from your branch. Provide a clear and concise description of your changes.

  5. Review Process: Your pull request will be reviewed by the project maintainers. Please be patient and address any feedback or requested changes.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for your contributions and support!