From 9900293251dba1724243f4eaf2100ae4b2450d8c Mon Sep 17 00:00:00 2001 From: Guilherme NUNES TROFINO Date: Mon, 23 Feb 2026 14:06:26 -0300 Subject: [PATCH] docs: add CONTRIBUTING file --- CONTRIBUTING.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7c17b29 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,98 @@ + +# Contributing to Dolphin + +First off, thanks for taking the time to contribute! + +All types of contributions are encouraged and valued. See the [Table of Contents](#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 maintainers and smooth out the experience for all involved. + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project: +> - Star the project +> - Refer the project to others + + +## Table of Contents + +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) +- [Styleguides](#styleguides) + - [Commit Messages](#commit-messages) + + + +## I Have a Question + +> If you want to ask a question, we assume that you have read the [README](./README.md). + +Before you ask a question, it is best to search for existing [Issues](https://github.com/tr0fin0/dolphin/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](https://github.com/tr0fin0/dolphin/issues/new). +- Provide as much context as you can about what you're running into. + +We will then take care of the issue as soon as possible. + +## I Want To Contribute + +> ### Legal Notice +> 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 licence. + +### Reporting Bugs + + +#### Before Submitting a Bug Report + +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 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. +- 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](https://github.com/tr0fin0/dolphin/issues?q=label%3Abug). +- Also make sure to search the internet to see if users outside of the project have discussed the issue. +- Collect information about the bug: + - Stack Trace + - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) + - Can you reliably reproduce the issue? And can you also reproduce it with older versions? + + +#### How Do I Submit a Good Bug Report? + +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. + +We use GitHub issues to track bugs and errors. If you run into an issue with the project: + +- Open an [Issue](https://github.com/tr0fin0/dolphin/issues/new) using the adequate template. +- Explain the behavior you would expect and the actual behavior. +- Provide the information you collected in the previous section. +- Please describe the *reproduction steps* that someone else can follow to recreate the issue on their own. + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for LaTeX CV, **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. + + +#### Before Submitting an Enhancement + +- Ensure that you are using the latest version. +- Read the [README](./README.md) carefully and find out if the functionality is already covered. +- Search for existing [Issues](https://github.com/tr0fin0/dolphin/issues) 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. + + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://github.com/tr0fin0/dolphin/issues). + +- 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. +- **Explain why this enhancement would be useful** to most LaTeX CV users. + +## Styleguides +### Commit Messages + +We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. This provides a clear history and allows automatic [CHANGELOG](./CHANGELOG.md) generation. + + +## Attribution +This guide is based on the [contributing.md](https://contributing.md/generator)! \ No newline at end of file