Skip to content

Latest commit

 

History

History
79 lines (46 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

79 lines (46 loc) · 2.84 KB
Raw

Contributing to helm-mirror

Welcome! We're excited that you're interested in contributing to helm-mirror. This project was originally created by openSUSE but it seems it has been abandoned. By forking and continuing development, we aim to breathe new life into it and welcome contributions from the community to help achieve this goal.

How to Contribute

We welcome all kinds of contributions, including bug fixes, new features, documentation improvements, and more. Here are some ways you can help:

  • Reporting Bugs: Found a bug? Please create an issue describing the problem and any steps to reproduce it.
  • Suggesting Features: Have an idea for a new feature? Open an issue to discuss it.
  • Submitting Pull Requests: Ready to contribute code? Fork the repository, make your changes, and submit a pull request.

Contribution Guidelines

To make the process smooth for everyone, please follow these guidelines:

1. Fork the Repository

Fork the repository on GitHub and clone your fork locally:

git clone https://github.com/konstructio/helm-mirror.git
cd helm-mirror

2. Create a Branch

Create a branch for your changes:

git checkout -b my-feature-branch

3. Make Your Changes

Make your changes in the branch you created.

4. Commit Your Changes

Commit your changes with a clear and descriptive message. Please ensure all commits are signed with either an SSH or GPG key. This helps us verify that you agree to contribute your code to the project.

git commit -s -m "Add a brief message describing the changes"

5. Push Your Changes

Push your changes to your forked repository:

git push origin my-feature-branch

6. Create a Pull Request

Go to the original repository on GitHub and create a pull request. Provide a clear description of your changes and any relevant information.

Code of Conduct

We are committed to fostering a welcoming and inclusive community. To ensure a positive environment for everyone, please follow the Contributor Covenant Code of Conduct for Kubefirst and Konstruct.io.

Keeping the Spirit of Copyleft

While this project is licensed under the Apache License, Version 2.0, we encourage contributions to be made with the spirit of copyleft in mind. This means:

  • Sharing modifications and improvements with the community.
  • Maintaining open and collaborative development practices.

License

By contributing to this project, you agree that your contributions will be licensed under the Apache License, Version 2.0.

Questions?

If you have any questions or need further assistance, feel free to open an issue.

Thank you for your interest in contributing to helm-mirror! Your efforts and contributions are highly appreciated.

Happy coding!