Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

54 lines (35 loc) · 2.02 KB

Contributing to karman

Thank you for your interest in contributing to karman! Your contributions help make this project better for everyone.

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please open an issue on our Issues page. Provide a clear description of the issue, steps to reproduce it, and any relevant screenshots or logs.

Suggesting Features

We welcome feature suggestions! If you have an idea for improving karman, open an issue with a detailed description of the feature and why you think it would be valuable.

Contributing Code

To contribute code, please follow these steps:

  1. Fork the Repository: Click the "Fork" button on the top-right of this page to create your own copy of the repository.
  2. Create a Branch: Create a new branch for your changes. 
    git checkout -b feature/your-feature
  3. Make Changes: Implement your changes on your branch.
  4. Commit Your Changes: Write a clear and concise commit message. 
    git commit -am "Add feature: your feature description"
  5. Push to GitHub: Push your changes to your forked repository. 
    git push origin feature/your-feature
  6. Open a Pull Request: Open a pull request on the experimental repository. Provide a detailed description of your changes and why they are needed.

Code Style

Testing

Before submitting a pull request, make sure that your changes do not break existing functionality and add any necessary tests for new features.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

Thank You!

Your contributions are greatly appreciated. Together, we can make karman even better!

This document is licensed under the GNU General Public License v3.0 (GPL-3.0).