remote/moderncv
1
0
Fork 0
mirror of https://github.com/moderncv/moderncv.git synced 2026-05-28 04:46:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

adds a contributing guidelines for moderncv and references it in the README.md file

Browse source
This commit is contained in:
LLdaniel 2026-02-22 18:25:11 +01:00 • committed by Mark E. Fuller
commit 438e38fcc0
No known key found for this signature in database
GPG key ID: D1CB9BCF4D87185F
2 changed files with 50 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

49
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,49 @@
# Contributing to moderncv
First off, thanks for taking the time to contribute to *moderncv*! ❤️
All types of contributions are encouraged and valued.
In order to make the contribution experience easier for both maintainers and contributors, please read the below listed guidelines.
The *moderncv* community is looking forward to your contributions.
## Questions about moderncv
If there are questions about *moderncv* our `manual/moderncv_userguide.pdf` is a good starting point. Also our `template.tex` follows the approach to comment on options available in *moderncv*.
In case you are still left with question marks, feel free to raise an issue or join our matrix room [moderncv:matrix.org](https://matrix.to/#/#moderncv:matrix.org) for a discussion.
## Reporting issues and suggesting enhancements
Bug reports and enhancement suggestions are welcome under our GitHub [issues section](https://github.com/moderncv/moderncv/issues). First have a look at the existing reports, maybe your issue is already addressed? In case you have additional information just add a comment to the existing reports. Otherwise create a new issue.
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 and use the prepared templates.
- 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 (see `manual/moderncv_userguide.pdf`)
- Collect information about the bug like how it can be triggered, which compiler and OS you are using and if you can provide a log file or a minimal example
- Can you reliably reproduce the issue? Give some instructions how to trigger the issue - as we all know, reproducing the error is half the fix already
After filing the issue, we will then take care of it as soon as possible.
## Making contributions
> ### Legal Notice
> When contributing to this project, you must agree that you have the necessary rights to the content and that the content you contribute may be provided under the project's LPPL-1.3c license (see `LICENSE.txt`).
The best way to add a contribution is to create your own fork of this project first. After creating a separate branch and pushing your changes, please open up a pull request for a review.
### Common practice
Please make sure that:
- your commits have a explanatory **commit message** what was changed in the source code
- your **branch name** contains a short hint to what is going to be changed
- you use a clear and descriptive **title** of the pull request
- you **explain shortly** what you intend to change with your pull request
### Moderncv specifics
Please make sure that the following requirements are met for your pull request:
- Document your changes in the `manual/moderncv_userguide.tex` if they changed the behavior of *moderncv* or introduced new features
- Write a small line in the `CHANGELOG` to keep track of changes and reference the issue, which will be solved with your pull request
In case you have the feeling that a more detailed discussion is needed for your pull request or you want to discuss your changes beforehand, just feel free to join our matrix room [moderncv:matrix.org](https://matrix.to/#/#moderncv:matrix.org).
Inspired by [contributing.md](https://contributing.md/).

1
README.md
View file

@ -30,6 +30,7 @@ If you are using the [`academicons`](https://ctan.org/tex-archive/fonts/academic
As the main goal is to keep this package alive, it is maintained in a loosely structured team.
You can contact us in our matrix room [moderncv:matrix.org](https://matrix.to/#/#moderncv:matrix.org), feel free to join if you have questions or want to contribute.
Development takes place at [github.com/moderncv/moderncv](https://github.com/moderncv/moderncv).
We are always happy if you want to contribute. Before you start, please make sure to read our guidelines in `CONTRIBUTING.md`.
## Licence