* Re: [OUTREACHY] Added a submitting a proposal doc to maintenance
2020-09-19 14:22 [OUTREACHY] Added a submitting a proposal doc to maintenance Gábor Boskovits
@ 2020-09-21 8:14 ` zimoun
0 siblings, 0 replies; 2+ messages in thread
From: zimoun @ 2020-09-21 8:14 UTC (permalink / raw)
To: Gábor Boskovits, Guix-devel
[-- Attachment #1: Type: text/plain, Size: 842 bytes --]
Hi Gábor,
On Sat, 19 Sep 2020 at 16:22, Gábor Boskovits <boskovits@gmail.com> wrote:
> 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 ’visual-line-mode’ with Emacs I guess (in such case, it should
be added on the top “# -*- mode:visual-line -*-“ :-)). 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
[-- Attachment #2: patch fix typos --]
[-- Type: text/x-diff, Size: 17497 bytes --]
From a9efac788ef9b3a8bbf8626e42f554e2ba736395 Mon Sep 17 00:00:00 2001
From: zimoun <zimon.toutoune@gmail.com>
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/submitting-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 description is for that.
+** Project title: Descriptive, short, no need to explain it, the long description is for that.
** Project long description
-*** Should provide context, namely at least a link about guix and other relevant software.
-*** Should provide a glossay of terms that are stricly related to guix (For example package is a well known term, while substitute might need explanation)
+*** Should provide context, namely at least a link about Guix and other relevant 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 editor)
+ - 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
-- 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
-For general instructions see:
+ For general instructions see:
-http://guix.gnu.org/en/videos/
+ http://guix.gnu.org/en/videos/
-For installation instruction see:
+ For installation instruction see:
-The installation from script video here:
+ The installation from script video here:
-http://guix.gnu.org/en/videos/
+ http://guix.gnu.org/en/videos/
-or the relevant section of the manual here:
+ or the relevant section of the manual here:
-https://guix.gnu.org/manual/en/html_node/Installation.html
+ https://guix.gnu.org/manual/en/html_node/Installation.html
-For instruction on how to build from a checkout see:
+ For instruction on how to build from a checkout see:
-https://guix.gnu.org/manual/en/html_node/Building-from-Git.html
+ https://guix.gnu.org/manual/en/html_node/Building-from-Git.html
-For instructions on how to run the tests see:
+ For instructions on how to run the tests see:
-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
-For a recommended development setup see:
+ For a recommended development setup see:
-https://guix.gnu.org/manual/en/html_node/The-Perfect-Setup.html
+ https://guix.gnu.org/manual/en/html_node/The-Perfect-Setup.html
*** 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 editor)
-
-- Having the guix testsuite run on a current checkout
-
-For general instructions 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
-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
-The installation from script video here:
+ For general instructions see:
-http://guix.gnu.org/en/videos/
+ http://guix.gnu.org/en/videos/
-or the relevant section of the manual here:
+ For installation instruction see:
-https://guix.gnu.org/manual/en/html_node/Installation.html
+ The installation from script video here:
-For instruction on how to build from a checkout see:
+ http://guix.gnu.org/en/videos/
-https://guix.gnu.org/manual/en/html_node/Building-from-Git.html
+ or the relevant section of the manual here:
-For instructions on how to run the tests see:
+ https://guix.gnu.org/manual/en/html_node/Installation.html
-https://guix.gnu.org/manual/en/html_node/Running-the-Test-Suite.html
+ For instruction on how to build from a checkout see:
-For a recommended development setup see:
+ https://guix.gnu.org/manual/en/html_node/Building-from-Git.html
-https://guix.gnu.org/manual/en/html_node/The-Perfect-Setup.html
+ For instructions on how to run the tests see:
-*** 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*)
+ https://guix.gnu.org/manual/en/html_node/Running-the-Test-Suite.html
-** contributions
+ For a recommended development setup see:
-Initial contribution possibilities(H4)
-Packaging software(H5)
-For packaging instructions see:
+ https://guix.gnu.org/manual/en/html_node/The-Perfect-Setup.html
-https://guix.gnu.org/cookbook/en/html_node/Packaging-Tutorial.html#Packaging-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*)
-and
+** Contributions
+*** Initial contribution possibilities
+**** Packaging software
+ For packaging instructions see:
-https://guix.gnu.org/manual/en/html_node/Defining-Packages.html#Defining-Packages
+ https://guix.gnu.org/cookbook/en/html_node/Packaging-Tutorial.html#Packaging-Tutorial
-Packaging software is a good first contribution candidate, it is not so hard to do, but ensures that everything is working on the installation, and is a lasting contribution to Guix. Good initial candidate packages are R packages, as Guix includes a well working recursive importer for R packages.
+ and
-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#Defining-Packages
-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 installation, and
+ is a lasting contribution to Guix. Good initial candidate packages are 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.
-- doc/guix.texi (a rendered version is here: https://guix.gnu.org/manual/en/guix.html)
+ The source files of these are located at:
-- doc/guix-cookbook.texi (a rendered version is here: https://guix.gnu.org/cookbook/en/html_node/index.html)
+ - doc/guix.texi (a rendered version is
+ here: https://guix.gnu.org/manual/en/guix.html)
-Working on bugs(H5)
-Working on any bug and creating a contibution by that is also a possibility. 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 something else instead, but this can make a good later contibution, or if you already have a bug fixed, then feel free to register that as a first contribution.
+ - doc/guix-cookbook.texi (a rendered version is
+ here: https://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/
-General Information(H4)
-For you initial contributions and system setup you can find general material about guix here:
-
-http://guix.gnu.org/en/videos/
** Repository: https://savannah.gnu.org/git/?group=guix
** Issue tracker: http://issues.guix.gnu.org/
** Newcomer issue tag: easy
-** Intern tasks: separate these according to the following structure if possible: 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 conrtibutions.
-* Mentor profile: feel free to fill this as it seems to fit. This is essentially your personal inforamtion.
+** Is your project open to new contributions: My project is open to new contributions.
+* 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 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 problem is on track, but just delayed, 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 problem 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 password to join this chat.
-Please make sure to add a nick and a password to your account, as only registered 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 password
+ to your account, as only registered users are allowed to talk on the
+ channel. For further information see:
+ https://freenode.net/kb/answer/registration
-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 everyone on the channel. Use nickname: to direct your message to someone. Most clients 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 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.
+ 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 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
+ 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.
-The only required field is the email address.
+ The only required field is the email address.
-Click subscribe to send the subscription request.
+ Click subscribe to send the subscription request.
-You will soon receive a 'welcome to the mailing list' email to the specified address.
+ You will soon receive a 'welcome to the mailing list' email to the
+ specified address.
-Please make sure that after subscribing to the list you write an email introducing 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.
-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.
-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.
+ 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.
-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.
-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.
+ 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.
+ Please keep communication public, so that the community as a whole can
+ help.
*** Documentation URL: leave empty
--
2.28.0
^ permalink raw reply related [flat|nested] 2+ messages in thread