diff --git a/.github/workflows/build-userguide-pdf.yml b/.github/workflows/build-userguide-pdf.yml index 665b93c..d49c04f 100644 --- a/.github/workflows/build-userguide-pdf.yml +++ b/.github/workflows/build-userguide-pdf.yml @@ -49,6 +49,8 @@ jobs: apt update && apt install git -y git config --global user.name '${{ env.UG_AUTHOR }}' git config --global user.email '${{ github.actor }}@users.noreply.github.com' + # prevent error message due to mismatch in users: process in gh actions vs. owner of repo + git config --global --add safe.directory /__w/moderncv/moderncv ls -l git add manual/moderncv_userguide.pdf git commit -m "${{ env.UG_COMMIT_MESSAGE }}" diff --git a/CHANGELOG b/CHANGELOG index 384d3b6..eec2a43 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -6,6 +6,9 @@ version next - Decreasing the size of born symbol to "tiny" and raising it by .5ex, to look typograpically more in line with born symbols outside moderncv (#273) - Fix missing Senders Name in Header (#278) +- Document an additional example in the userguide on how to adjust the skill matrix (#213) +- Adds contributing guidelines for moderncv (#275) + version 2.5.1 (31 Jan 2026) - Fix french babel breaking contemporary style (#219) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..83a7b7c --- /dev/null +++ b/CONTRIBUTING.md @@ -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/). diff --git a/README.md b/README.md index 19ff062..089d8d8 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/manual/moderncv_userguide.tex b/manual/moderncv_userguide.tex index 3e2ed27..68e4428 100644 --- a/manual/moderncv_userguide.tex +++ b/manual/moderncv_userguide.tex @@ -98,7 +98,7 @@ cvitem, cventry, cvdoubleentry, cvdoubleitem, cvtripleitem, cvlistitem, cvlistdoubleitem, cvcolumns, moderncvstyle, moderncvcolor, cvskill, cvskilllegend, cvskillplainlegend, cvskillhead, cvskillentry, nopagenumbers, name, born, address, email, link, social, phone, homepage, extrainfo, photo, quote, section, subsection, setlength, NewDocumentCommand, definecolor, colorlet, cvitemwithcomment, - recipient, subject, opening, closing, signature, postscript, enclosure + recipient, subject, opening, closing, signature, postscript, enclosure, makelettertitle, makeletterclosing }, emphstyle={\color{cvblue}}, emph={[2] @@ -615,6 +615,18 @@ A command to list the attached documents. The first optional parameter allows a \enclosure[]{} \end{lstlisting} +\paragraph{\code{\\makelettertitle}} +A command to create the whole cover letter title before beginning with the letter's body. +\begin{lstlisting} + \makelettertitle +\end{lstlisting} + +\paragraph{\code{\\makeletterclosing}} +A command to create the closing paragraph after the letter's body. +\begin{lstlisting} + \makeletterclosing +\end{lstlisting} + \note If typesetting the resume in Chinese using CJK an additional \code{\\clearpage} is required after the \code{\\makeletterclosing} command. This helps \code{fancyhdr} to work correctly with CJK. Otherwise it will remove the page numbering by making \code{lastpage} undefined. \section{Customization} @@ -908,7 +920,13 @@ The width of the quote can be adjusted by setting \code{\\quotewidth}. Due to in \subsubsection{Lengths in the skill matrix} \label{section:length:skillmatrix} -Both the width of the skill matrix legend and the width of the skill matrix columns can be adjusted. +Both the width of the skill matrix legend and the width of the skill matrix columns can be adjusted. In general there are three measures available to change the width, which are: +\begin{itemize} +\item absolute values depending on the font like \code{5em} +\item factors in the range from $0$ to $1$ +\item width measuring words and sentences like \code{\\widthof\{``Year''\}} +\end{itemize} + The width of the skill matrix legend can be adjusted as follows: \begin{lstlisting} @@ -933,6 +951,23 @@ The width of the skill matrix columns can be adjusted as follows: \end{lstlisting} \code{} and \code{} should be lengths smaller than \code{\\textwidth}, and \code{} must be between 0 and 1. +\subsubsection{Additional example for column length adjustments} +The following code snippet illustrates an additional example of length adjustments and tries to explain the effects for the different columns. +Adjusting one column affects the other ones as the total width of the skill matrix stays the same. +\begin{lstlisting} + % narrow the "skill" column (at the same time giving more space to the comment column) + % reading like: being 25\% of the default column space + \setcvskillcolumns[][0.25][] + + % decrease the size of "years" giving more space to "skills" + \setcvskillcolumns[][][0.05\textwidth] + + % combining the above will help to increase the "comment" column. + % Thinking of it like save space for "years" and "skills" + % in favor of the "comment" + \setcvskillcolumns[][0.25][0.05\textwidth] +\end{lstlisting} + \subsection{Additional link commands}%% adapted from Cristina Sambo's documentation To create links to a website or a email address, use the following commands: