community-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rlenfer...@apache.org
Subject [comdev-site] branch master updated: Update mentor-request-mail.md
Date Sun, 13 Dec 2020 15:14:46 GMT
This is an automated email from the ASF dual-hosted git repository.

rlenferink pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/comdev-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 0e4fb83  Update mentor-request-mail.md
     new aea453e  Merge pull request #45 from cottage14/patch-30
0e4fb83 is described below

commit 0e4fb83b58f420a632fa298c193c3e2ad67391fe
Author: Andrew Wetmore <andrew@cottage14.com>
AuthorDate: Sun Dec 13 09:34:53 2020 -0400

    Update mentor-request-mail.md
    
    Text and grammar edits.
---
 source/mentor-request-mail.md | 36 ++++++++++++++++--------------------
 1 file changed, 16 insertions(+), 20 deletions(-)

diff --git a/source/mentor-request-mail.md b/source/mentor-request-mail.md
index 8c70282..0eec8a9 100644
--- a/source/mentor-request-mail.md
+++ b/source/mentor-request-mail.md
@@ -2,22 +2,22 @@
 title: "How To: Write A Mentor Request Email"
 ---
 
-Having identified a project and an issue you would like to work on it is a
+Having identified a Top Level Project (TLP) and an issue you would like to work on, it is
a
 good idea to introduce yourself to the project community and outline your
-plans for tackling the issue. This means the community know you are working
+plans for tackling the issue. This lets the community know you are working
 on the issue and gives the community an early opportunity to help course
-correct your proposal if necessary (which can save lots of time). 
+correct your proposal, if necessary (which can save you lots of time). 
 
-Here's an example of what your first most might look like:
+Here's an example of what your first email might look like:
 
 ```text  
 SUBJECT: A proposal for Skinnable widgets (WOOKIE-131)
 
 Hi, I'm new to the Wookie project but I'd like to tackle the "Skinnablewidgets" 
-issue (WOOKIE-131, see [1]). Before I launch into implementing this I'd like to 
+issue (WOOKIE-131, see [1]). Before I start implementing this I'd like to 
 run my ideas past you to make sure I'm not missing something important.
 
-If I understand the issue correctly we need to define the structure of a minimal 
+If I understand the issue correctly, we need to define the structure of a minimal 
 widget. For example:
 
 <div id="wookie-widget">
@@ -38,16 +38,13 @@ We also need to provide a default CSS for rendering this as, for example:
 |FOOTER 		|
 +-----------------------+
 
-This will need to be documented and all widgets should be changed to conform to 
+We need to document all this (how to use it and how to extend it) on the Wookie website,
and change all widgets to conform to 
 this format.
 
-We would need to document this on the Wookie website and also document how to 
-extend this.
-
 Once all this is in place I would like to start extending it to provide documented 
-CSS identifiers to be used in common cases, for example, we may want to define 
-"wookie-navigation" as being used for a common navigation menu. We can then provide 
-various CSS alternatives for rending this as a vertical navigation menu or drop down 
+CSS identifiers to use in common cases. For example, we may want to define a
+"wookie-navigation" style for a common navigation menu. We can then provide 
+various CSS alternatives for rending this as a vertical navigation menu, drop down 
 menu, or whatever.
 
 Am I on the right track? Are there any important points I'm missing?
@@ -55,10 +52,9 @@ Am I on the right track? Are there any important points I'm missing?
 [1]  https://issues.apache.org/jira/browse/WOOKIE-131
 ```
 
-There are two main advantages to sending a mail like this. Firstly, you
-force yourself to think carefully about what is needed and whether you
-have the skills (and thus where you will need help). Secondly, it allows
-people in the community to provide input. For example, in the above case
-the community would probably point out that there is a widget template
-system that needs to be modified to ensure this format is used
-consistently.
+There are two main advantages to sending a mail like this. First, you
+force yourself to think carefully about what the project requires and whether you
+have the skills to do it (and thus where you will need help). Second, it lets
+people in the community provide input. For example, in the above case
+the community might point out that there is a widget template
+system that would need modification to use this format consistently.


Mime
View raw message