From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id YB9UCW5haF8LUQAA0tVLHw (envelope-from ) for ; Mon, 21 Sep 2020 08:16:46 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id qM8jBW5haF93dQAAbx9fmQ (envelope-from ) for ; Mon, 21 Sep 2020 08:16:46 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 9F3BC9402B1 for ; Mon, 21 Sep 2020 08:16:45 +0000 (UTC) Received: from localhost ([::1]:34360 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kKH08-0006Ad-Hw for larch@yhetil.org; Mon, 21 Sep 2020 04:16:44 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:48948) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kKGxy-0004p8-9r for guix-devel@gnu.org; Mon, 21 Sep 2020 04:14:30 -0400 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]:53210) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kKGxu-0000Au-Vg for guix-devel@gnu.org; Mon, 21 Sep 2020 04:14:29 -0400 Received: by mail-wm1-x332.google.com with SMTP id q9so11194743wmj.2 for ; Mon, 21 Sep 2020 01:14:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:in-reply-to:references:date:message-id:mime-version; bh=8207m3Oyzel2HsYDKm3nmoUUtwdvv8P5gxT1XtRLC1I=; b=BugRTlhB3l9sZnhaJ1UkUoX6U20X/huZxcDwH+QC5mIMbppi17mR779FxAxkJCXISh zkVLSz0NlxrItEiRUj9/umHKpkR520xOf3idMNAze7zWFS7/bikrKjIKfYsaDi7TiL/+ 7TWWm602QWZ8bWStGG4xhner5OLD8IGpwZewoSx9qUl0J6XjEbMhIUcq0kL983wnJqM/ nhyNEX474MBi7L3NnvFcfQjYyjfNfULnHg25MxUbrw98L2deDAm1CMyFkp1mjob5NZnI AHpim/RF77FFd6bKUy85Irg7SZTj8su7UftcyuSb0HNYVubHuKxrVD5HnKNxQnvPKltt GYTA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:in-reply-to:references:date :message-id:mime-version; bh=8207m3Oyzel2HsYDKm3nmoUUtwdvv8P5gxT1XtRLC1I=; b=hspYRqQ5+xHBRbOFdVCkYbtEX8m6eZtyvMWLXoEIXBUnpIM5qhUA7y7qx1K+Asg6WK llhgSia4krjVA3TujNj1ILauLTzwQp84qszxQGZqydHVXv2FicXy51+1tU++7ganKhTZ rJG5/00QQGgnB92P5+sWYBuSAXlNYiyVJipNcKtFtJXILWlNK6vyTEoKpt8d3wgVyety ItOJlb3dZGLY+Ynhs0aVszcyWd3J4GUYM8ccNSSYKkaPUUYf8BZLLPX1M4ha02WsQehr d0Ng/0OKsIHhP2kpNGNI5DwAQeT3yOwamiqgPZpuDEp1hwpJCKuFC2+b8ttYe6L4Mxb5 /2ng== X-Gm-Message-State: AOAM5329CEIMEn9DFSe2XcGwnO8uFZn7FMmEK2cdu+UM9C9R7rfJ6Mb9 pgatL1ZYw/V+LfdPZif526NFBd20vik= X-Google-Smtp-Source: ABdhPJzmY8rC564hTvelt9RWqnvuECdyhq0uCDbBqcOZ+jaxdUJBrSseeUre8yaOn5XjAOpvrfz4WQ== X-Received: by 2002:a7b:c958:: with SMTP id i24mr30082359wml.50.1600676064925; Mon, 21 Sep 2020 01:14:24 -0700 (PDT) Received: from lili ([2a01:e0a:59b:9120:65d2:2476:f637:db1e]) by smtp.gmail.com with ESMTPSA id f23sm35952393wmc.3.2020.09.21.01.14.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 21 Sep 2020 01:14:24 -0700 (PDT) From: zimoun To: =?utf-8?Q?G=C3=A1bor?= Boskovits , Guix-devel Subject: Re: [OUTREACHY] Added a submitting a proposal doc to maintenance In-Reply-To: References: Date: Mon, 21 Sep 2020 10:14:22 +0200 Message-ID: <86mu1jr1gh.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=2a00:1450:4864:20::332; envelope-from=zimon.toutoune@gmail.com; helo=mail-wm1-x332.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, WEIRD_PORT=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: "Guix-devel" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20161025 header.b=BugRTlhB; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of guix-devel-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-devel-bounces@gnu.org X-Spam-Score: -1.71 X-TUID: kXqf5HMz+YnE --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Hi G=C3=A1bor, On Sat, 19 Sep 2020 at 16:22, G=C3=A1bor Boskovits wr= ote: > Hello guix, > I added a submitting a proposal file to maintenance, that > describes what the community specific fields should look like, > and also some recommendations on the rest. The project specific fields > and the mentor specific fields can't be filled in form these, but I > still > believe this can help to shorten this process. Thank you. You use =E2=80=99visual-line-mode=E2=80=99 with Emacs I guess (in such case= , it should be added on the top =E2=80=9C# -*- mode:visual-line -*-=E2=80=9C :-)). IMO= it is harder to read long lines document without Emacs. Well, attached, a patch that fixes some typos, fills paragraphs and re-indents. Feel free to push it if it makes sense. Thank you again for this document. All the best, simon --=-=-= Content-Type: text/x-diff; charset=utf-8 Content-Disposition: inline; filename=0001-doc-outreachy-Fix-typos.patch Content-Transfer-Encoding: quoted-printable Content-Description: patch fix typos >From a9efac788ef9b3a8bbf8626e42f554e2ba736395 Mon Sep 17 00:00:00 2001 From: zimoun Date: Sun, 20 Sep 2020 09:33:08 +0200 Subject: [PATCH] doc: outreachy: Fix typos. * doc/outreachy/submitting-a-proposal.org: Fix typos. --- doc/outreachy/submitting-a-proposal.org | 247 ++++++++++++++---------- 1 file changed, 145 insertions(+), 102 deletions(-) diff --git a/doc/outreachy/submitting-a-proposal.org b/doc/outreachy/submit= ting-a-proposal.org index 3641a91..6069643 100644 --- a/doc/outreachy/submitting-a-proposal.org +++ b/doc/outreachy/submitting-a-proposal.org @@ -1,181 +1,224 @@ +# -*- mode:org -*- + * Project details ** Approved license: yes ** No proprietary software: yes ** How long has your team been accepting publicly submitted contributions:= More than 2 years ** How many regular contributors does your team have: More than 100 people -** Project title: Desciptive, short, no need to explain it, the long descr= iption is for that.=20 +** Project title: Descriptive, short, no need to explain it, the long desc= ription is for that. ** Project long description -*** Should provide context, namely at least a link about guix and other re= levant software. -*** Should provide a glossay of terms that are stricly related to guix (Fo= r example package is a well known term, while substitute might need explana= tion) +*** Should provide context, namely at least a link about Guix and other re= levant software. +*** Should provide a glossary of terms that are strictly related to Guix. + For example package is a well known term, while substitute might need = explanation ** System requirements *** General -- A working development setup for the kind of project -*** For projects on guix -- A working installation for guix -- A working development setup for guix -- Having the testsuites run on the checkout -- A working installation of guix - -- A working development setup for guix (at least git and a capable text ed= itor) + - A working development setup for the kind of project +*** For projects on Guix + - A working installation for Guix + - A working development setup for Guix + - Having the test-suites run on the checkout =20 -- Having the guix testsuite run on a current checkout + - A working installation of Guix + - A working development setup for Guix (at least git and a capable text + editor) + - Having the Guix testate run on a current checkout =20 -For general=C2=A0instructions see: + For general=C2=A0instructions see: =20 -http://guix.gnu.org/en/videos/ + http://guix.gnu.org/en/videos/ =20 -For installation instruction see: + For installation instruction see: =20 -The installation from script video here: + The installation from script video here: =20 -http://guix.gnu.org/en/videos/ + http://guix.gnu.org/en/videos/ =20 -or the relevant section of the manual here: + or the relevant section of the manual here: =20 -https://guix.gnu.org/manual/en/html_node/Installation.html + https://guix.gnu.org/manual/en/html_node/Installation.html =20 -For instruction on how to build from a checkout see: + For instruction on how to build from a checkout see: =20 -https://guix.gnu.org/manual/en/html_node/Building-from-Git.html + https://guix.gnu.org/manual/en/html_node/Building-from-Git.html =20 -For instructions on how=C2=A0to run the tests see: + For instructions on how=C2=A0to run the tests see: =20 -https://guix.gnu.org/manual/en/html_node/Running-the-Test-Suite.html + https://guix.gnu.org/manual/en/html_node/Running-the-Test-Suite.html =20 -For a recommended development setup see: + For a recommended development setup see: =20 -https://guix.gnu.org/manual/en/html_node/The-Perfect-Setup.html + https://guix.gnu.org/manual/en/html_node/The-Perfect-Setup.html =20 *** For projects on gnu system -- A working installation of GNU System, either on bare metal, or in a VM -- A working development setup for guix -- Having the testsuites run on the checkout -- (Optional) Having the system tests run on the checkout -- A working installation of guix - -- A working development setup for guix (at least git and a capable text ed= itor) - -- Having the guix testsuite run on a current checkout - -For general=C2=A0instructions see: - -http://guix.gnu.org/en/videos/ + - A working installation of GNU System, either on bare metal, or in a = VM + - A working development setup for Guix + - Having the test-suites run on the checkout + - (Optional) Having the system tests run on the checkout + - A working installation of Guix =20 -For installation instruction see: + - A working development setup for Guix (at least git and a capable text + editor) + - Having the Guix test-suite run on a current checkout =20 -The installation from script video here: + For general instructions see: =20 -http://guix.gnu.org/en/videos/ + http://guix.gnu.org/en/videos/ =20 -or the relevant section of the manual here: + For installation instruction see: =20 -https://guix.gnu.org/manual/en/html_node/Installation.html + The installation from script video here: =20 -For instruction on how to build from a checkout see: + http://guix.gnu.org/en/videos/ =20 -https://guix.gnu.org/manual/en/html_node/Building-from-Git.html + or the relevant section of the manual here: =20 -For instructions on how=C2=A0to run the tests see: + https://guix.gnu.org/manual/en/html_node/Installation.html =20 -https://guix.gnu.org/manual/en/html_node/Running-the-Test-Suite.html + For instruction on how to build from a checkout see: =20 -For a recommended development setup see: + https://guix.gnu.org/manual/en/html_node/Building-from-Git.html =20 -https://guix.gnu.org/manual/en/html_node/The-Perfect-Setup.html + For instructions on how=C2=A0to run the tests see: =20 -*** For projects independent of guix, but under the community umbrella=20 -- whatever is required for this project -- whatever is required to perform the integration of the project into guix= (most probably this includes everything under *For projects on guix*) + https://guix.gnu.org/manual/en/html_node/Running-the-Test-Suite.html =20 -** contributions + For a recommended development setup see: =20 -Initial contribution possibilities(H4) -Packaging software(H5) -For packaging instructions see: + https://guix.gnu.org/manual/en/html_node/The-Perfect-Setup.html =20 -https://guix.gnu.org/cookbook/en/html_node/Packaging-Tutorial.html#Packagi= ng-Tutorial +*** For projects independent of Guix, but under the community umbrella + - whatever is required for this project + - whatever is required to perform the integration of the project into = Guix + (most probably this includes everything under *For projects on Guix*) =20 -and +** Contributions +*** Initial contribution possibilities +**** Packaging software + For packaging instructions see: =20 -https://guix.gnu.org/manual/en/html_node/Defining-Packages.html#Defining-P= ackages + https://guix.gnu.org/cookbook/en/html_node/Packaging-Tutorial.html#Pa= ckaging-Tutorial =20 -Packaging software is a good first contribution candidate, it is not so ha= rd to do, but ensures that everything is working on the installation, and i= s a lasting contribution to Guix. Good initial candidate packages are R pac= kages, as Guix includes a well working recursive importer for R packages. + and =20 -Refining current documentation(H5) -Contributions to the manual, and also to the Guix Cookbook are welcome. + https://guix.gnu.org/manual/en/html_node/Defining-Packages.html#Defin= ing-Packages =20 -The source files of these are located at: + Packaging software is a good first contribution candidate, it is not = so + hard to do, but ensures that everything is working on the installatio= n, and + is a lasting contribution to Guix. Good initial candidate packages ar= e R + packages, as Guix includes a well working recursive importer for R + packages. +**** Refining current documentation + Contributions to the manual, and also to + the Guix Cookbook are welcome. =20 -- doc/guix.texi (a rendered version is here:=C2=A0https://guix.gnu.org/man= ual/en/guix.html) + The source files of these are located at: =20 -- doc/guix-cookbook.texi (a rendered version is here:=C2=A0https://guix.gn= u.org/cookbook/en/html_node/index.html) + - doc/guix.texi (a rendered version is + here:=C2=A0https://guix.gnu.org/manual/en/guix.html) =20 -Working on bugs(H5) -Working on any bug and creating a contibution by that is also a possibilit= y. However, it might be quite hard to estimate the invesment needed to fix = a bug. It is recommended to record your first contribution by doing somethi= ng else instead, but this can make a good later contibution, or if you alre= ady have a bug fixed, then feel free to register that as a first contributi= on. + - doc/guix-cookbook.texi (a rendered version is + here:=C2=A0https://guix.gnu.org/cookbook/en/html_node/index.html) +*** Working on bugs + Working on any bug and creating a contribution by that + is also a possibility. However, it might be quite hard to estimate the + investment needed to fix a bug. It is recommended to record your first + contribution by doing something else instead, but this can make a good + later contribution, or if you already have a bug fixed, then feel free= to + register that as a first contribution. +*** General Information + For you initial contributions and system setup you can find general + material about Guix here: + http://guix.gnu.org/en/videos/ =20 -General Information(H4) -For you initial contributions and system setup you can find general materi= al about guix here: - -http://guix.gnu.org/en/videos/ ** Repository: https://savannah.gnu.org/git/?group=3Dguix ** Issue tracker: http://issues.guix.gnu.org/ ** Newcomer issue tag: easy -** Intern tasks: separate these according to the following structure if po= ssible: Starting tasks, Milestones, Stretch Goals, set these to(H5) +** Intern tasks + Separate these according to the following structure if possible: + - Starting tasks + - Milestones + - Stretch Goals ** Intern benefits: please, try to fill this ** Community benefits: please, try to fill this ** Unapproved license description: leave empty ** Proprietary software description: leave empty -** Is your project open to new contributions: My project is open to new co= nrtibutions. -* Mentor profile: feel free to fill this as it seems to fit. This is essen= tially your personal inforamtion. +** Is your project open to new contributions: My project is open to new co= ntributions. +* Mentor profile: feel free to fill this as it seems to fit. + This is essentially your personal information. * Project skills: require here only what is needed. -There is one thing I suggest very strongly, and it's good communication sk= ills. -As this is a full remote internship it is of crucial importance to circula= te information fast about any blockers, -so that time is not wasted. It is not a problem if a goal is not reached o= n it's proposed deadline, but you have to -keep track of what is happening, if the problem is on track, but just dela= yed, and you have to discuss a modified timeline. + There is one thing I suggest very strongly, and it's good communication + skills. As this is a full remote internship it is of crucial importance= to + circulate information fast about any blockers, so that time is not + wasted. It is not a problem if a goal is not reached on it's proposed + deadline, but you have to keep track of what is happening, if the proble= m is + on track, but just delayed, and you have to discuss a modified timeline. * Communication channels ** Channel #1: *** tool name: IRC *** URL: irc://irc.freenode.net:6667/#guix *** Instructions on joining: -If you are asked for username, pick any username! You will not need a pass= word to join this chat. -Please make sure to add a nick and a password to your account, as only reg= istered users are allowed to talk on the channel. -For further information see: https://freenode.net/kb/answer/registration + If you are asked for username, pick any username! You will not need a + password to join this chat. Please make sure to add a nick and a pass= word + to your account, as only registered users are allowed to talk on the + channel. For further information see: + https://freenode.net/kb/answer/registration =20 -Please make sure to introduce yourself on this channel. + Please make sure to introduce yourself on this channel. *** Community norms: -Please make sure to familiarize yourself with the Code of Conduct. You can= find a local version in the CODE-OF-CONDUCT file in the source tree. - -Please note, that when talking on IRC in general you are addressing everyo= ne on the channel. Use nickname: to direct your message to someone. Most cl= ients have an autocompletion feature when you type a tabulation. - -Guix's IRC channel is open to communication in any language people want to= engage in, but please remember that your mentors might not understand your= language. English is the only language understood by all your mentors and = other community members, and is therefore mandatory when you want to commun= icate results or have questions about the internship. - -IRC has the capability to open private communication channels, but experie= nce has shown that communication should be public, unless there is a very c= ompelling (most of the time legal or security) reason to make it private. - -Please keep communication public, so that the community as a whole can hel= p. + Please make sure to familiarize yourself with the Code of Conduct. You= can + find a local version in the CODE-OF-CONDUCT file in the source tree. + + Please note, that when talking on IRC in general you are addressing + everyone on the channel. Use nickname: to direct your message to + someone. Most clients have an auto-completion feature when you type a + tabulation. + + Guix's IRC channel is open to communication in any language people wan= t to + engage in, but please remember that your mentors might not understand = your + language. English is the only language understood by all your mentors = and + other community members, and is therefore mandatory when you want to + communicate results or have questions about the internship. + + IRC has the capability to open private communication channels, but + experience has shown that communication should be public, unless there= is + a very compelling (most of the time legal or security) reason to make = it + private. + + Please keep communication public, so that the community as a whole can + help. *** Communication tool documentation URL: https://freenode.net/kb/all ** Channel #2: *** tool name: mailing list *** URL:_https://lists.gnu.org/mailman/listinfo/guix-devel *** Instructions on joining -Please visit the mailing list subscription page, then fill in the form. + Please visit the mailing list subscription page, then fill in the form. =20 -The only required field is the email address. + The only required field is the email address. =20 -Click subscribe to send the subscription request. + Click subscribe to send the subscription request. =20 -You will soon receive a 'welcome to the mailing list' email to the specifi= ed address. + You will soon receive a 'welcome to the mailing list' email to the + specified address. =20 -Please make sure that after subscribing to the list you write an email int= roducing yourself. + Please make sure that after subscribing to the list you write an email + introducing yourself. *** Community norms -Please CC your mentors on the mails sent to the list. + Please CC your mentors on the mails sent to the list. =20 -Please also make sure that when answering to mail you answer to all. + Please also make sure that when answering to mail you answer to all. =20 -Please make sure, that when answering emails you do not top post, and you = answer questions and add remarks right after quoting the relevant part of t= he original message. You can remove long parts of messages you are not answ= ering to. + Please make sure, that when answering emails you do not top post, and = you + answer questions and add remarks right after quoting the relevant part= of + the original message. You can remove long parts of messages you are not + answering to. =20 -Please make sure to familiarize yourself with the Code of Conduct. You can= find a local version in the CODE-OF-CONDUCT file in the source tree. + Please make sure to familiarize yourself with the Code of Conduct. You= can + find a local version in the CODE-OF-CONDUCT file in the source tree. =20 -Experience has shown that communication should be public, unless there is = a very compelling (most of the time legal or security) reason to make it pr= ivate. + Experience has shown that communication should be public, unless there= is + a very compelling (most of the time legal or security) reason to make = it + private. =20 -Please keep communication public, so that the community as a whole can hel= p. + Please keep communication public, so that the community as a whole can + help. *** Documentation URL: leave empty=20 --=20 2.28.0 --=-=-=--