Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (25 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 2.39 KB
Raw

Contributing to Cynthia Java Client

Thank you for your interest in contributing to the Cynthia Java Client! We appreciate your effort and look forward to collaborating with you to improve the project. The following guidelines will help you understand the contribution process and ensure a smooth experience for both you and the project maintainers.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before engaging in any communication or submitting contributions to the project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix.
  4. Make your changes, ensuring they follow the project's coding standards and guidelines.
  5. Commit your changes, using clear and concise commit messages that describe the purpose of the changes.
  6. Push your changes to the branch on your forked repository.
  7. Create a pull request, providing detailed information about your changes and the problem they solve.

Pull Request Guidelines

  • Before submitting a pull request, make sure you have merged the latest changes from the main branch into your feature or bug fix branch.
  • Always create a new branch for each feature or bug fix, and ensure it is based on the main branch.
  • Ensure your code is well-documented and follows the project's coding standards.
  • Write clear and concise commit messages that describe the purpose of the changes.
  • Provide a detailed description in the pull request, explaining the changes and their purpose, as well as any relevant information that will help the maintainers review your contribution.
  • Make sure your pull request only contains changes related to the feature or bug fix described in the description.

Reporting Issues

If you encounter any bugs or issues while using the Cynthia Java Client, please open a new issue in the repository. When reporting an issue, please provide the following information:

  • A clear and concise title for the issue.
  • A detailed description of the issue, including steps to reproduce it, the expected behavior, and the actual behavior.
  • Any relevant information about your environment, such as your Java version, operating system, and any other libraries or tools you are using.

We appreciate your help in making the Cynthia Java Client even better. Thank you for your contributions!