Skip to content

Latest commit

 

History

History
31 lines (26 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

31 lines (26 loc) · 2.87 KB
Raw

Contributing to Charty

Welcome to Charty! We appreciate your interest in contributing to this open-source project. By contributing, you can help improve the library, add new features, fix issues, and make Charty even better for the community.

How Can You Contribute?

  • Reporting Issues: If you encounter any bugs or issues while using Charty, please let us know by creating a new issue in the issue tracker . Provide a detailed description, steps to reproduce, and any relevant information to help us investigate and address the problem.
  • Feature Requests: Have a great idea for a new feature or improvement? We'd love to hear it! Open a new issue in the issue tracker and clearly explain the proposed feature or enhancement. We'll review your suggestion and provide feedback.
  • Pull Requests: Want to contribute code to Charty? You can submit a pull request with your changes. Please follow the guidelines below:
    • Fork the repository and create a new branch for your changes.
    • Ensure your code adheres to the project's coding style and conventions.
    • Write clear, concise, and meaningful commit messages.
    • Include tests for your changes whenever applicable. Tests help ensure the stability and reliability of the library.
    • Update the documentation to reflect any changes or additions.
    • Submit the pull request, providing a detailed description of your changes and their purpose.
    • Documentation Improvements: You can help improve the Charty documentation by fixing typos, clarifying explanations, adding examples, or expanding on existing content. Submit a pull request with your documentation changes, ensuring they follow the same guidelines as code contributions.

    Code Style and Conventions

To maintain consistency within the project, please adhere to the following guidelines:

  • Follow the existing code style and formatting conventions.
  • Use meaningful variable and function names that reflect their purpose.
  • Add comments to explain complex logic or provide context when necessary.
  • Write clear and concise code that is easy to understand and maintain.
  • Ensure your code is well-tested, following the existing testing patterns and conventions.
  • Try running ./gradlew detekt and ./gradlew ktlintCheck

Code of Conduct

Contributors are expected to adhere to the Code of Conduct when participating in the Charty project. Be respectful, inclusive, and considerate of others. Any form of harassment, discrimination, or abusive behavior will not be tolerated.

Getting Help

If you need any assistance, have questions, or require further clarification, feel free to reach out by creating a new issue or contacting the project maintainers.

Thank you for your contributions and support in making Charty a valuable tool for data visualization in the Android community!