Add instructions to mentors on how to add ideas #61
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -76,4 +76,7 @@ defaults: | |
| type: projects | ||
| values: | ||
| layout: | ||
| exclude: | ||
| - _projects/_template.md | ||
| - _projects/README.md | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # IDEAS for OpenAstronomy | ||
|
|
||
| Please, if you have any issue with the following steps contact your org admin or | ||
| ask in the multi-client real-time | ||
| [chat platform we have](http://openastronomy.org/) (Thanks @Cadair!). | ||
| The steps are set up from the point of view of I have an idea, what do I need so | ||
| it's online - so the hardest steps are towards the bottom, and you read only up | ||
| to the point you feel confident. | ||
|
|
||
| *TLDR - Are you an expert?* Fork the repo and modify | ||
| the [template file](./_template.md) according to your idea, save it under | ||
| `_projects/YYYY/sub-org/` with a meaningful filename and do a Pull-request. | ||
|
|
||
| ## What to I need to have an idea? | ||
|
|
||
| You are here, so that's the first step! | ||
|
|
||
| You need to have a description and a list of candidate mentors. Which requirements | ||
| do you think are needed (_e.g._, knowing c++, expertise in OOP)? How difficult | ||
| would you say it's the project? Is there already an issue related with that idea? | ||
|
|
||
| If you have all that then think in an attractive project title and a one line | ||
| description. Then you put all in one file as explained below. | ||
|
|
||
| You can make your idea with very specific milestones or as open ended as you | ||
| want. Either way is good. If it's very specific the students will know how to | ||
| write an application as you wanted, but leave less freedom for different | ||
| approaches. | ||
|
|
||
| ## Format needed | ||
|
|
||
| Cool, you've got already all the above? | ||
|
|
||
| All you need now is to put it in a plain text file following | ||
| the [template file](./_template.md) (you may click in raw to see how it looks). | ||
|
|
||
| The file is composed in two parts (separated by a `---`), the top is like a yaml | ||
|
There was a problem hiding this comment. "like a"? I'm not sure what you mean by that. I'm also not sure it's that important for a mentor to know that? Maybe just drop the part after the first comma in this sentence? There was a problem hiding this comment. the top uses yaml formatting, the rest markdown. But sure, now it's simpler. |
||
| file, the bottom is in markdown format. Change the text in the template keeping | ||
| special care of the structure of the yaml file and the headings on the markdown | ||
| part (_e.g._, the top level starts with a 4 level title: `####`). | ||
|
|
||
|
|
||
| ## How do I do so it appears online? | ||
|
|
||
|
|
||
| Are you familiar with git/github? If you are not contact us and share the above | ||
| file with us, we will take care to put it in place. | ||
|
There was a problem hiding this comment. Say who "us" is - give a specific email address or something like that. Remember that if someone doesn't find the information necessary to submit in idea in this document, they probably won't submit anything... Ridiculously low barrier to entry is the goal! |
||
| If, in the other hand, you are feel confident with github: go ahead, fork this | ||
| repository, create a subdirectory for your sub-organisation (if that doesn't | ||
|
There was a problem hiding this comment. I think this needs to be very specific. For example, "find the subdirectory for your sub-organisation and the year of the project (for example, if you are submitting an astropy project, go to /_projects/2017/astropy). If your organization does not exist, create it following the form of one of the other organizations." |
||
| exist yet) under the year of the GSOC edition you want to put your idea in and | ||
| add your previously created file there. Create a pull-request and that's it! | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| name: Example Astropy | ||
| desc: This is the first idea for astropy | ||
|
There was a problem hiding this comment. What's the difference between this, and the "description" below? I suggest removing this and having the name be the only "description" in this section There was a problem hiding this comment. This is a one line description - it appears on the box together with the title. Added a description in the comment. |
||
| # add a description of your project | ||
| requirements: | ||
| - The proposal has to contain a clear concept. | ||
|
There was a problem hiding this comment. I don't understand what this section means. Requirements for the student? Like "knows some astronomy"? Or requirements for the project? There was a problem hiding this comment. For the student - Changed accordingly. |
||
| - patch on any astropy affiliated package. | ||
| difficulty: low | ||
| issues: | ||
| - https://github.com/astropy/astropy/issue/4444 | ||
| - https://github.com/astropy/astropy/issue/5555 | ||
| mentors: | ||
|
There was a problem hiding this comment. This should be "possible mentors"? We never know until the project starts, of course. There was a problem hiding this comment. But that should be the point of contact at the moment for the student writing the application. |
||
| - astrofrog | ||
| initiatives: | ||
| - GSOC | ||
| - SOCIS | ||
| tags: | ||
|
There was a problem hiding this comment. What does this mean? I think without structure people will be confused by what they're supposed to do with it. I suggest leaving it off. There was a problem hiding this comment. I've added a description, |
||
| - python | ||
| collaborating_projects: | ||
| - astropy | ||
|
There was a problem hiding this comment. Again, why is this here? Isn't the file going to already be in the astropy section? There was a problem hiding this comment. Not the directory structure is just to keep the things in order. This is to be able to separate them by sub-orgs and enables cross-collaborative project. |
||
| --- | ||
| This is an awesome project idea for Astropy. | ||
|
|
||
| #### Description | ||
|
|
||
| Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus aliquam | ||
| turpis neque, vel fermentum diam gravida id. Maecenas tempor magna libero, non | ||
| faucibus dolor tincidunt non. Sed condimentum imperdiet odio sed volutpat. | ||
| Mauris imperdiet viverra turpis a porttitor. Duis laoreet leo sit amet odio | ||
| suscipit aliquet. Etiam vel malesuada est, in molestie nibh. Sed efficitur | ||
| pharetra lorem, sed tempor sapien commodo ac. Vivamus sollicitudin pretium erat. | ||
| Pellentesque luctus vehicula tortor, nec volutpat turpis euismod vel. Sed neque | ||
| ipsum, imperdiet nec massa sit amet, accumsan lobortis augue. Donec luctus massa | ||
| vitae velit scelerisque volutpat ut nec ex. Sed in velit tincidunt, volutpat | ||
| turpis sit amet, dignissim nisi. Donec a mattis eros. Pellentesque vitae leo | ||
| quam. | ||
|
|
||
| #### Milestones | ||
|
There was a problem hiding this comment. Add a note along the lines of "note that Milestones are not necessary - just leaving a description is sufficient if you don't have milestones." When I looked at this I assumed the milestones were mandatory, and only by looking at the README did I realize it's not... |
||
|
|
||
| ##### GSOC 2017 CODING STARTS | ||
|
|
||
| * Be awesome | ||
|
|
||
| ##### GSOC 2017 MIDTERM | ||
|
|
||
| * Have done awesome stuff. | ||
|
|
||
| ##### GSOC 2017 FINAL | ||
|
|
||
| * Finished the awesome stuff. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to->do?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks, done.