Thank you for considering contributing to the DevOps Tools Cheatsheet Collection! Your contributions help make this project a valuable resource for the DevOps community.
By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand the expected behavior when contributing to the project.
Tip
We welcome various types of contributions, including but not limited to:
- Adding New Cheatsheets: Share your knowledge about a tool not yet covered.
- Improving Existing Cheatsheets: Update or enhance the content in existing files.
- Fixing Issues: Help resolve any bugs or errors found in the repository.
- Providing Feedback: Suggest new features, improvements, or corrections.
-
Fork the Repository: Start by forking this repository to your GitHub account.
-
Create a New Branch: Create a new branch in your fork for your contribution. For example:
git checkout -b add-toolname-cheatsheet
-
Make Your Changes: Edit or add files as necessary. Follow the format of existing cheatsheets for consistency.
-
Commit Your Changes: Write a clear and descriptive commit message. For example:
git commit -m "Add cheatsheet for ToolName" -
Push Your Changes: Push the changes to your forked repository:
git push origin add-toolname-cheatsheet
-
Submit a Pull Request: Go to the original repository and submit a pull request. Provide a clear description of your changes and why they are beneficial.
Note
- Your pull request will be reviewed by the maintainers of the project.
- Please be patient, as reviews can take some time depending on the complexity of the changes.
- You may be asked to make changes before your pull request is accepted.
When adding a new cheatsheet, please ensure it is placed in the correct directory based on its category (e.g., CI-CD, Containerization, Monitoring, etc.). This helps maintain an organized structure for easy navigation.
Tip
For consistency, please follow this basic format for new cheatsheets:
- Tool Name: Title the file with the tool name (e.g.,
Docker.md). - Sections: Include sections such as Basic Commands, Tips, Configuration, etc.
- Examples: Provide examples wherever possible.
- Formatting: Use Markdown for formatting (headings, bullet points, code blocks).
Important
- Be Respectful: Keep interactions respectful and constructive.
- Ask for Help: If you're unsure about anything, feel free to ask in the discussion section.
- Stay on Topic: Make sure your contributions align with the purpose of this repository.
By contributing to this repository, you agree that your contributions will be licensed under the MIT License.