check_description.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/check_description.R
\name{check_description}
\alias{check_description}
\title{Check the \code{DESCRIPTION} file}
\usage{
check_description(x = ".")
}
\arguments{
\item{x}{Either a \code{checklist} object or a path to the source code.
Defaults to \code{.}.}
}
\description{
The \code{DESCRIPTION} file contains the most important meta-data of the package.
A good \code{DESCRIPTION} is tidy, has a meaningful version number, full
author details and a clear license.
}
\details{
This function ensures the \code{DESCRIPTION} is tidy, using \code{tidy_desc()}.

The version number of the package must have either a \code{0.0} or a \verb{0.0.0}
format (see \href{https://github.com/inbo/checklist/issues/1}{this discussion} why
we allow only these formats).
The version number in every branch must be larger than the current version
number in the main or master branch.
New commits in the main or master must have a larger version number than the
previous commit.
We recommend to protect the main or master branch and to not commit into the
main or master.

Furthermore we check the author information.
\itemize{
\item Is INBO listed as copyright holder and funder?
\item Has every author an ORCID?
}

We check the license through \code{check_license()}.
}
\seealso{
Other package: 
\code{\link{check_codemeta}()},
\code{\link{check_cran}()},
\code{\link{check_documentation}()},
\code{\link{check_environment}()},
\code{\link{check_license}()},
\code{\link{check_package}()},
\code{\link{tidy_desc}()}
}
\concept{package}