👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to KubeRocketCI Cache (krci-cache), hosted in the KubeRocketCI Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the KubeRocketCI Cache Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the KubeRocketCI community maintainers.
This section guides you through submitting a bug report for KubeRocketCI Cache. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating issues, please perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
Bugs are tracked as GitHub issues. Create an issue on repository and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started krci-cache, e.g. which command exactly you used in the terminal, or how you started krci-cache otherwise. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
Include details about your configuration and environment:
- Which version of krci-cache are you using?
- What's the name and version of the operating system you're using?
- Are you running krci-cache in a container, Kubernetes, or as a binary?
- What's your krci-cache configuration (environment variables)?
This section guides you through submitting an enhancement suggestion for krci-cache, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
Before creating enhancement suggestions, please perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Enhancement suggestions are tracked as GitHub issues. Create an issue on repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of krci-cache which the suggestion is related to.
- Explain why this enhancement would be useful for KubeRocketCI pipelines.
- Which version of krci-cache are you using?
- What's the name and version of the operating system you're using?
krci-cache can be developed locally. For instructions on how to do this, see the following sections in the Local Development documentation.
The process described here has several goals:
- Maintain krci-cache quality
- Fix problems that are important to users
- Engage the community in working toward the best possible krci-cache
- Enable a sustainable system for krci-cache maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Follow standard Go formatting using
gofmt - Follow Effective Go guidelines
- Use meaningful variable and function names
- Add comments for exported functions and complex logic
- Write unit tests for new functionality
- Keep functions focused and small
- Handle errors appropriately - don't ignore them
When contributing to krci-cache, please keep security in mind:
- Validate all user inputs, especially file paths and upload parameters
- Be careful with file operations to prevent path traversal attacks
- Consider the security implications of new features
- Review authentication and authorization logic carefully
- Test with malicious inputs when applicable
krci-cache is designed to handle large file uploads and downloads efficiently:
- Consider memory usage when processing large files
- Use streaming for file operations when possible
- Test performance impact of changes with large files
- Document any performance implications in your PR