Contribution Guidelines

Contributing to Stevedore

Thank you for your interest in contributing to Stevedore! All contributions are welcome, whether they are bug reports, feature requests, or code contributions.

Getting Started

Before contributing to Stevedore, you should:

1. Fork the repository.
2. Clone the repository to your local machine.
3. Set up a development environment.
4. Create a new branch for your changes.

How to Contribute

Bug Reports

If you find a bug in Stevedore, please report it by creating a new issue on our GitHub repository. Please include as much information as possible, including a description of the bug, the steps to reproduce it, and any error messages you received.

Feature Requests

If you have a feature request, please create a new issue on our GitHub repository. Please include a detailed description of the feature, as well as any relevant use cases or examples.

Code Contributions

If you would like to contribute code to Stevedore, please follow these steps:

1. Create a new branch for your changes.
2. Make your changes.
3. Submit a pull request.

Please ensure that your code adheres to our coding standards, that all tests pass before submitting a pull request, and you update the project README, the documentation, and the RELEASE_NOTES.

Coding Standards

When contributing code to Stevedore, please adhere to the following coding standards:

• Use clear, descriptive variable and function names.
• Use comments to explain complex code.
• Follow the existing code style, including indentation and formatting.
• Write tests for your code.

Issue Management

We use GitHub to manage issues and feature requests. To report a bug or request a feature, please create a new issue on our GitHub repository.

Documentation

Documentation is an important part of the Stevedore project, and we rely on contributions from our community to keep it up-to-date. If your contribution involves changes to the behaviour of the Stevedore project, please make sure to update the documentation accordingly. This could include updating the README file, adding or modifying usage examples, or creating new documentation pages as needed. We encourage all contributors to participate in improving the documentation, as it helps ensure that the project is accessible and useful to as many people as possible.

Thank You

Thank you for your interest in contributing to Stevedore! All contributions are appreciated.