Thanks in advance for taking the time to contribute.
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
If you like the project, but you just don't have enough time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which would make us happy:
- Star the project
- Tweet about it
- Refer this project in your project's README
- Mention the project at local meetups and tell your friends/collegues
This project and everyone participating in it is governed by RAUDI Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
If you want to ask a question, we assume that you have read the available Documentation.
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue that follows this issue template.
- Provide as much context as you can about what you're running into.
- Provide platform versions (Python, Docker, etc.), depending on what seems relevant.
We will then take care of the issue as soon as possible.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
We continuously work to add new cool features to RAUDI and provide new automatically updated tools. If you don't want to jump right into the code you may contribute by adding a new tool to our arsenal. Before continuing in this section please carefully read the documentation (in particular read the section 'Tool Structure' that highlights how a tool's folder is composed.).
The following rules MUST be followed when adding a new tool:
- Check if the tool has already been added (check in the /tools folder or in the documentation in the 'Available Tools' section)
- Use a helper to automatically retrieve the latest available version for the tool (read the specific section in the documentation about Helpers)
- Follow the naming conventions for versions (ONLY DIGITS AND DOTS); strip out and replace any other characters
- If you add a test command please verify that it returns a 0 status code by running RAUDI with the
--pushoption. Otherwise leave it blank. - Use common_args for Base Distro version
The following rules SHOULD be followed when adding a new tool as they are best practices:
- Use the minimum number of RUN commands
- Use alpine-based images
- Check if there is a Docker Image for the same tool that has a much more small size than yours
After adding a new tool you may make a PR as described in the specific section.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86)
- Version of the Python, Docker, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
You must never report security related issues, vulnerabilities or bugs to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [email protected].
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue that follows this issue template.
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as
needs-repro. Bugs with theneeds-reprotag will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked
needs-fix, as well as possibly other tags (such ascritical), and the issue will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for RAUDI, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a 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.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
Enhancement suggestions are tracked as GitHub issues.
- Open an Issue that follows this issue template.
- 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.
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to.
- Explain why this enhancement would be useful to most RAUDIT users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
If you want to fix a bug or propose a new feature you can also create a Pull Request.
- Check if there is an Issue that highlights the same problem that you want to solve or that requests the same feature that you want to implement. If this is the case, then remember to link the Issue in your Pull Request.
- Check if a similar Pull Request has already been created.
- Consider creating an Issue before creating a Pull Request.
- Use a clear and descriptive title for the Pull Request.
- Follow this Pull Request template.
- Link the Issue related to this Pull Request, if present.
- Provide a step-by-step description of the solution you proposed in as many details as possible.
- Use comments in the code that you provide.
This guide is based on the contributing-gen. Make your own!