Write a wiki page on joining the BRL-CAD projectBRL-CAD
Status: ClosedTime to complete: 100 hrs Mentors: Kesha Shah, Hardeep Singh RaiTags: wiki, writing, article, english, proseBeginner

There are many ways to get involved with the BRL-CAD project. Like many open source projects, we have a community of contributors but it's not always clear to someone new (like yourself) how one can get involved.

This task requires learning about what possible ways one may contribute and to then write a page on our wiki explaining ways to contribute for others.

Here are some fantastic examples to follow and use as a reference:

  • https://wiki.gnome.org/JoinGnome
  • https://wiki.ubuntu.com/ContributeToUbuntu
  • http://www.freebsd.org/doc/en_US.ISO8859-1/articles/contributing/
  • http://en.flossmanuals.net/contributors-guide-to-brl-cad/

Research the possible ways one can contribute to open source projects, learn about how people contribute to BRL-CAD (search the web, ask questions, search our website), and submit your article here. The wiki page/article you write should be modeled closely after the Gnome example but note that we do not have a lot of the same "teams" they do, but we do have similar ways to contribute.

When we agree that a draft looks good, you'll then upload your article to http://brlcad.org/wiki/Join

Uploaded Work
File name/URLFile sizeDate submitted
http://brlcad.org/wiki/Talk:Joiningthebrlc...n/aDecember 01 2014 19:20 UTC
THE BRL.docx14.3 KBDecember 01 2014 19:20 UTC
THE BRL-updated.docx15.1 KBDecember 03 2014 15:27 UTC
BRL-CAD.docx9.6 KBDecember 07 2014 06:19 UTC
http://brlcad.org/wiki/Main_Pagen/aDecember 07 2014 06:20 UTC
BRL-CAD.docx9.6 KBDecember 07 2014 06:20 UTC
BRL-CAD project.docx5.7 KBDecember 08 2014 17:29 UTC
BRL-CAD.docx4.7 KBDecember 09 2014 18:34 UTC
Comments
alexbardon December 1 2014 17:19 UTCTask Claimed

I would like to work on this task.

Sean on December 1 2014 17:22 UTCTask Assigned

This task has been assigned to alexbard. You have 100 hours to complete this task, good luck!

alexbardon December 1 2014 19:20 UTCReady for review

The work on this task is ready to be reviewed.

Mihai Neacsu on December 1 2014 20:11 UTCTask Needs More Work

One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.

Mihai Neacsu on December 1 2014 20:13 UTCFormatting and punctuation

You might want to improve formatting, separate the body of the article into paragraphs, it's hard to follow when there's not a clear separation between ideas. BRL-CAD's wiki page uses Media Wiki, you can find their formatting markup here:


http://www.mediawiki.org/wiki/Help:Formatting 


 


Also, check the punctuation, there's one ellipsis ("...") that's missing a dot.


It would be best if you would leave a space between the punctuation marks and the characters following. So instead of "So , what is the BRL-CAD project ? BRL-CAD...", you would have "So, what is the BRL-CAD project? BRL-CAD...".

alexbardon December 1 2014 20:20 UTCThanks for the feedback

Thanks for the recommendations . I will work on it more

alexbardon December 3 2014 15:27 UTCReady for review

The work on this task is ready to be reviewed.

Sean on December 4 2014 01:58 UTCTask Needs More Work

One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.

Sean on December 4 2014 02:05 UTCinconsistencies

Alex, I'm not feeling it... there are various formatting concerns but those are irrelevant without first considering the content itself.


Take the very first paragraph, for example.  You start out by saying there are many ways to get involved and that it's not always clear how to get involved.  However, nowhere do you actually tell them how to get involved.  The closest you get is mentioning that there are a wide range of activities.


Please read the first three examples to see how this information looks for Gnome, Ubuntu, and FreeBSD.  We need a page that captures the same simplicity and clarity as those examples.


 

Melange on December 4 2014 21:22 UTCTask due soon

There are less than 24 hours left until the deadline, please submit your work soon.

Melange on December 5 2014 21:22 UTCTask Reopened

Melange has detected that the final deadline has passed and it has reopened the task.

bhargavon December 6 2014 08:39 UTCTask Claimed

I would like to work on this task.

Ishwerdas on December 6 2014 09:04 UTCTask Assigned

This task has been assigned to bhargav. You have 100 hours to complete this task, good luck!

bhargavon December 6 2014 09:50 UTC

thanks Ishwerdas. I just want to know whether i need to give  a brief introduction or lengthy explation  in my document about ways others  may  contribute to BRL-CAD project.


 

bhargavon December 7 2014 06:19 UTCReady for review

The work on this task is ready to be reviewed.

Harmanpreet on December 7 2014 15:34 UTCTask Needs More Work

One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.

Harmanpreet on December 7 2014 15:49 UTCGood efforts

Hi bhargav,


I appreciate that you referred different sources to write down your article. Since this article is just an introduction to new comers so we don't need to put details and it should not be too lengthy; shorter is better. I already touched different aspects so all you need to do is to just write in your own words in an interesting way rather than copy pasting the details.


You have made a good progress and the little refinements will further refine the article.


Good luck!

bhargavon December 8 2014 15:18 UTC

Thanks harmanpreet for your suggestions 


I will work according to your suggestions and will upload my task in few hours


 

bhargavon December 8 2014 17:29 UTCReady for review

The work on this task is ready to be reviewed.

Sean on December 9 2014 06:06 UTCTask Needs More Work

One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.

Sean on December 9 2014 06:20 UTCbetter!

Bhargav, this is looking good and you have some of the expected content, but the biggest issue I see is that there is way too much irrelevant information.  Per your 1, 2, and 3 scoping questions, I think only #3 is relevant (how to contribute) as that is exactly the scope of this task.  It's assumed that by the time someone will get to this page that they will know what BRL-CAD is and some of what it can do.


Looking at just section #3, the following feedback comes to mind as other aspects to work on addressing:



  1. you begin by mentioning developer, documenter graphic artists, academics, and uncategorized contributors as being potentially interested.  however, you then only itemize Developers and "Documentors" (this is spelled wrong) as "ways" to contribute.

  2. the rest get categorized very generically in the "other ways" section without any information on how to contribute each of those types of contributions.

  3. it's not clear to me why you singled out developers and documenters but not the rest other than perhaps copying information from our book.

  4. copy editing!  there are many many typographical, spelling, and punctuation errors in your document.  please run it through a grammar and spell checker, and proof-read your writeup.  there's no way we could use this with so many errors in it.

  5. ":-" is redundant.  it should be "title:" or "section - " but not "title:-".

  6. the "Suggestion to new contributers" is a generic title and mispelled and does not fit the outline of the rest of the content.  the section clearly has something to do with communication methods,.

  7. are your final suggestions section intended to be links to other information?  they should either be links or actually point them to where those resources are located


 

Melange on December 9 2014 13:04 UTCTask due soon

There are less than 24 hours left until the deadline, please submit your work soon.

bhargavon December 9 2014 18:34 UTCReady for review

The work on this task is ready to be reviewed.

Sean on December 10 2014 05:06 UTCTask Closed

Congratulations, this task has been completed successfully.

Sean on December 10 2014 05:08 UTCgood improvements all around

Thanks bhargav, it looks like you addressed most of the feedback points very well.  It was a little confusing near the end of the document where you go from talking about polyglot contributions to immediately talking about GSoC and other programs, but that is easily fixed with a section header.  Hopefully we can put this to use to help attract new contributors.  Thank you for your efforts.