Skip to content

Commit

Permalink
langs
Browse files Browse the repository at this point in the history
  • Loading branch information
yegor256 committed Mar 21, 2024
1 parent af6be0d commit ece6d16
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 19 deletions.
3 changes: 1 addition & 2 deletions 01-debating/01-debating.tex
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,7 @@
\par
Github pull request:
\href{https://github.com/objectionary/eo/pull/2808}{objectionary/eo\#2808}
\end{multicols}
}
\end{multicols}}

\thought{In an argument, provide \ul{links} that support your point of view.}

Expand Down
37 changes: 26 additions & 11 deletions 05-setting-guidelines/05-setting-guidelines.tex
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,6 @@

\plush{\osbpTitlePage{5}{}}

% how to contribute
% documentation
% wiki
% commit comments

\thought{Have \ff{LICENSE.txt} file with an MIT license in your repository}

\qte
Expand Down Expand Up @@ -59,7 +54,7 @@
\end{tabular}}

\plush{\pptBanner{What permissions may be granted by a license?}
\begin{itemize}
\begin{itemize}\setlength\itemsep{0em}
\item Permission to \ul{use}
\item Permission to \ul{modify}
\item Permission to \ul{distribute}
Expand All @@ -75,13 +70,13 @@
{ben-balter}
{Unsurprisingly, \ul{MIT}, \ul{Apache}, and \ul{GPL} are the clear front runners, with some 15\% of licensed projects opting for a non-standard license.}
{github2015licenses}
\pitch{\includegraphics[width=.8\linewidth]{licenses.png}
\pitch{\includegraphics[width=.7\linewidth]{licenses.png}
\source{github2015licenses}}

\thought[bugayenko2019blog0423]{Make the \ff{README.md} file attractive}

\plush{\pptBanner{Mandatory sections of \ff{README.md}:}
\begin{itemize}
\begin{itemize}\setlength\itemsep{0em}
\item Title, logo, badges
\item What is it? What problem does it solve?
\item How to uick start?
Expand All @@ -98,8 +93,6 @@

\thought[bugayenko2014blog0721]{Make the \ff{master} branch read-only}

\thought{Don't explain coding guidelines, setup GitHub Action checks}

\thought{Put \ff{CODE\_OF\_CONDUCT.md} file to your repository... not}

\qte
Expand All @@ -111,10 +104,20 @@
\qte
[Parastou Tourani]
{parastou-tourani}
{We found that the top codes of conduct are adopted by hundreds to thousands of projects, while all of them share 5 common dimensions.}
{We found that the top codes of conduct are adopted by hundreds to thousands of projects, while all of them share five common dimensions.}
{tourani2017code}
\pitch{\includegraphics[width=.8\linewidth]{codes.png}
\source{tourani2017code}}
\pitch{
\begin{multicols}{2}
\includegraphics[width=.9\linewidth]{dimensions.png}
\source{tourani2017code}
\par\columnbreak\par
``The Contributor Covenant explicitly mentions sexualized language or imagery, trolling, insulting and publishing of private information of others as unexpected behaviors. Django adds discriminatory jokes and violent threats to this list. Geek Feminism and the Open code of conduct provide a more detailed list, ...''
\end{multicols}}

\plush{\pptBanner{Django Code of Conduct}
``We strive to be a community that welcomes and supports people of \ul{all} backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, \ul{political belief}, religion, and mental and physical ability.''}

\qte
[Dabbish Laura]
Expand All @@ -128,4 +131,16 @@
{We found multiple significant relationships between value-related discussions and turnover, including that discussions about \ul{respectfulness} predict an increase in contributors leaving and a decrease in new contributors, while discussions about \ul{social power} predicted better contributor retention.}
{jamieson2023predicting}

\thought{Don't explain coding guidelines, setup GitHub Action checks}

\plush{\pptBanner{Some exotic GitHub Action plugins:}
\begin{itemize}\setlength\itemsep{0em}
\item \href{https://github.com/hadolint/hadolint-action}{hadolint-action} for \ff{Dockerfile}
\item \href{https://github.com/marketplace/actions/markdown-lint}{markdownlint-action} for \ff{README.md}
\item \href{https://github.com/marketplace/actions/shellcheck}{shellcheck-action} for \ff{.sh} scripts
\item \href{https://github.com/Uno-Takashi/checkmake-action}{checkmake-action} for \ff{Makefile}
\item \href{https://github.com/ibiqlik/action-yamllint}{action-yamllint} for \ff{YAML} files
\item \href{https://github.com/yegor256/bibcop-action}{bibcop-action} for Bib\TeX \ff{.bib} files
\end{itemize}}

\end{document}
Binary file added 05-setting-guidelines/dimensions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion main.bib
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ @misc{stallman1985gnu
@misc{github2015licenses,
author = {Balter, Ben},
howpublished = {\url{https://github.blog/2015-03-09-open-source-license-usage-on-github-com/}},
month = {mar},
month = {March},
note = {[Online; accessed 20-03-2024]},
title = {{Open source license usage on GitHub.com}},
year = {2015},
Expand Down
6 changes: 6 additions & 0 deletions osbp.sty
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@
\RequirePackage{footmisc}
\RequirePackage{booktabs}
\RequirePackage{graphicx}
\RequirePackage{href-ul}

% see https://tex.stackexchange.com/a/256190/1449
\RequirePackage{url}
\def\UrlBreaks{\do\/\do-}
\RequirePackage{breakurl}

\usepackage{silence}
\WarningFilter{bibentry}{You have used \nobibliography*}
Expand Down
10 changes: 5 additions & 5 deletions syllabus/syllabus.tex
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,12 @@ \section*{Lectures \& Labs}

Most probably, one of the following repositories will be suggested
by the teacher for contribution during the course:
\href{https://github.com/yegor256/cam}{yegor256/cam},
\href{https://github.com/yegor256/rultor}{yegor256/rultor},
\href{https://github.com/yegor256/qulice}{yegor256/qulice},
\href{https://github.com/cqfn/jpeek}{cqfn/jpeek},
\href{https://github.com/yegor256/cam}{yegor256/cam} (Bash, Python),
\href{https://github.com/yegor256/rultor}{yegor256/rultor} (Java, XML),
\href{https://github.com/yegor256/qulice}{yegor256/qulice} (Java),
\href{https://github.com/cqfn/jpeek}{cqfn/jpeek} (Java, XML),
and
\href{https://github.com/objectionary/eo}{objectionary/eo}.
\href{https://github.com/objectionary/eo}{objectionary/eo} (Java, XSLT).

\newpage
\section*{Grading}
Expand Down

0 comments on commit ece6d16

Please sign in to comment.