Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 2.85 KB

contributing.md

File metadata and controls

89 lines (63 loc) · 2.85 KB

Contributing to Caitlyn

Thank you for your interest in contributing to Caitlyn! We welcome contributions from the community to help improve and expand the library. Please follow these guidelines to ensure a smooth process.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please open an issue on our GitHub Issues page. Provide as much detail as possible, including steps to reproduce the issue or examples of the desired feature.

Submitting Code Changes

  1. Fork the Repository: Click the "Fork" button on the GitHub repository page to create a personal copy of the repository.

  2. Clone Your Fork: Clone your forked repository to your local machine:

    git clone https://github.com/szawrowski/caitlyn.git

  3. Create a Branch: Create a new branch for your changes:

    git checkout -b feature/your-feature

  4. Make Changes: Implement your changes or new features. Ensure that your code adheres to our coding style and includes appropriate documentation and tests.

  5. Commit Your Changes: Commit your changes with a clear and concise message:

    git add .
git commit -m "Add new feature or fix bug"

  6. Push Your Changes: Push your changes to your forked repository:

    git push origin feature/your-feature

  7. Create a Pull Request: Go to the Pull Requests page of the Caitlyn repository and click "New Pull Request". Select your branch and provide a description of the changes you’ve made.

Code Style

Please follow these guidelines when contributing code:

  • Consistency: Maintain the existing coding style and conventions used in the project.
  • Comments: Write clear and concise comments where necessary to explain complex logic.
  • Documentation: Update documentation files if your changes affect the functionality or usage of Caitlyn.
  • Testing: Ensure that all new code is covered by tests and that existing tests pass.

Review Process

  • Your pull request will be reviewed by a maintainer. You may be asked to make additional changes based on the feedback.
  • Once approved, your pull request will be merged into the main branch.

Contributor License Agreement

By submitting code to Caitlyn, you agree to the terms of the Contributor License Agreement. Ensure you read and understand the agreement before contributing.

Thank You!

We appreciate your contribution and support. If you have any questions or need help, feel free to reach out via GitHub Discussions or email us at alexander.szawrowski@gmail.com.

Happy coding!