Skip to content

Latest commit

 

History

History
68 lines (54 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

68 lines (54 loc) · 3.23 KB

Contributing to hexagonal-cqrs-es-eda

Thank you for considering contributing to hexagonal-cqrs-es-eda We appreciate your interest and are excited to have you as part of our community. This document outlines the guidelines for contributing to this project.

Table of Contents

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it to understand our expectations regarding respectful communication and behavior.

Getting Started

To contribute to this project, please follow these steps:

  1. Fork the repository: Click the "Fork" button in the top right corner of the repository page.
  2. Clone your fork: Use the following command to clone the repository to your local machine: 
    git clone https://github.com/YOUR_USERNAME/[project-name].git
  3. Create a new branch: It's best practice to create a new branch for your changes: 
    git checkout -b my-feature-branch
  4. Set up the development environment: Make sure you have all the necessary dependencies and tools installed to work on the project. Follow the instructions in the project's README.md file.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue in the Issues section. When creating an issue, please provide:

  • A clear and descriptive title
  • A detailed description of the problem or feature
  • Steps to reproduce the issue (if applicable)
  • Any relevant screenshots or code snippets
  • Expected behavior and actual behavior

Submitting Changes

When you're ready to submit your changes, follow these steps:

  1. Commit your changes: Make sure your commit messages are clear and descriptive. Use the following format: 
    git commit -m "Add a brief description of the changes"
  2. Push your changes: Push your changes to your forked repository: 
    git push origin my-feature-branch
  3. Open a Pull Request: Go to the original repository and click on "New Pull Request". Select your branch and provide a description of your changes.

Testing Your Changes

Before submitting your pull request, ensure that all tests pass. To run the tests, use Maven:

mvn clean test

Make sure to add tests for any new features or bug fixes.

Documentation

If your changes include new features or modifications to existing features, please update the documentation accordingly. Documentation is crucial for users and other developers to understand how to use the project effectively. Update the relevant sections in the project's README.md file or other documentation files. If necessary, create or modify the Javadoc comments in the source code.

Getting Help

If you have any questions or need assistance, feel free to reach out by creating an issue or contacting us directly through our community channels. Thank you for contributing to hexagonal-cqrs-es-eda