From 051d959bc778c32507d71089bd6906bb6b1cf358 Mon Sep 17 00:00:00 2001 From: Dani Canet Date: Tue, 28 Dec 2021 14:20:53 +0100 Subject: [PATCH] docs: add support for conventional commits On our last Engineering teams lead meeting, we decided to adopt the Conventional Commits specification to commit messages to all our source code projects. Therefore, we need to update our Contributing guidelines section to adhere to this new standard and allow others to do, so. --- CONTRIBUTING.md | 180 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 8 ++- 2 files changed, 187 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..b6de986a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,180 @@ +# Contributing + +We would love for you to contribute to this project and help make it better. + +As a contributor, here are the guidelines we would like you to follow: + +- [Questions or problems?](#questions-or-problems) +- [Reporting issues](#reporting-issues) +- [Coding Rules](#coding-rules) +- [Commit Message Guidelines](#commit-message-guidelines) + +## Questions or problems + +Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. + +Instead, we recommend you sending an e-mail to [support@wiris.com](mailto:support@wiris.com) to ask support-related questions. + +## Reporting issues + +If you find a bug in the source code, you can help us by [submitting an issue](#submitting-an-issue) to our [GitHub Repository][github]. Even better, you can submit a Pull Request with a fix. + +### Submitting an Issue + +Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available. + +We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. + +In order to reproduce bugs, we require that you provide a minimal reproduction. +Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions. + +A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem. + +We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. +Often, developers find coding problems themselves while preparing a minimal reproduction. +We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it. + +Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced. + +You can file new issues by selecting from our [new issue templates](https://github.com/wiris/moodle-filter_wiris/issues/new/choose) and filling out the issue template. + +## Coding Rules + +To ensure consistency throughout the source code, keep these rules in mind as you are working: + +- Follow the [Commit Message Format guidelines](#commit-message-format). +- Lint all code. +- Once forked the project, create a new branch from `main` branch. + +## Commit Message Guidelines + +We have very precise rules over how our Git commit messages must be formatted. +This format leads to **easier to read commit history**. + +> **Note**: You don't need to use this specification to contribute to this project, but we encourage you to do, so. + +- Wrap message lines to about 72 characters or so. + +- Each commit message consists of a **header**, a **body**, and a **footer**. + +``` +
+ + + +