Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
125 lines (89 loc) · 4.3 KB

CONTRIBUTING.md

File metadata and controls

125 lines (89 loc) · 4.3 KB
Raw

Below is a standard contributing guide tailored for the Java module mesomb-java hosted on GitHub. You can customize it further to suit your project's specific needs.

Contributing to mesomb-java

Thank you for your interest in contributing to mesomb-java! We welcome contributions from the community to help improve this Java module. Whether you're fixing bugs, adding new features, or improving documentation, your contributions are highly appreciated.

Please take a moment to review this guide to ensure a smooth and efficient contribution process.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Development Setup
  5. Coding Standards
  6. Testing
  7. Commit Guidelines
  8. License

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand the expectations for behavior within the community.

Getting Started

  1. Fork the Repository: Start by forking the mesomb-java repository to your GitHub account.
  2. Clone the Repository: Clone your forked repository to your local machine: 
    git clone https://github.com/hachther/mesomb-java.git
cd mesomb-java
  3. Set Up Upstream: Add the original repository as an upstream remote: 
    git remote add upstream https://github.com/hachther/mesomb-java.git

How to Contribute

Reporting Bugs

  • Check Existing Issues: Before reporting a bug, please check the Issues page to ensure it hasn't already been reported.
  • Create a New Issue: If the bug is new, open an issue and provide:
    • A clear and descriptive title.
    • Steps to reproduce the issue.
    • Expected vs. actual behavior.
    • Java version, OS, and any relevant environment details.

Suggesting Enhancements

  • Open an Issue: Use the Issues page to suggest new features or improvements.
  • Provide Context: Explain the problem you're trying to solve and why your suggestion would be valuable.

Submitting Pull Requests

  1. Create a Branch: Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  2. Make Your Changes: Follow the Coding Standards and ensure your code is well-tested.
  3. Commit Your Changes: Write clear and concise commit messages (see Commit Guidelines).
  4. Push Your Changes: Push your branch to your forked repository: 
    git push origin feature/your-feature-name
  5. Open a Pull Request: Submit a pull request (PR) to the main branch of the original repository. Provide a detailed description of your changes and reference any related issues.

Development Setup

  1. Install Dependencies: Use Maven to install dependencies: 
    mvn install
  2. Set Up Environment: Copy the .env.example file to .env and configure it with your settings.

Coding Standards

  • Follow the Google Java Style Guide.
  • Use meaningful variable and method names.
  • Add comments where necessary to explain complex logic.

Testing

  • Write unit tests for new features or bug fixes using JUnit.
  • Run tests locally before submitting a PR: 
    mvn test
  • Ensure all tests pass and add new tests if applicable.

Commit Guidelines

  • Use the present tense ("Add feature" instead of "Added feature").
  • Keep commits small and focused on a single change.
  • Reference issues in your commit messages (e.g., "Fix #123: Bug in payment processing").

License

By contributing to mesomb-java, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to mesomb-java! Your efforts help make this project better for everyone.

Feel free to adjust this template to fit your project's specific needs.