Skip to content

Commit 0af2f48

Browse files
author
Raniere Silva
committed
Split CONTRIBUTING.md
As suggested by @willingc.
1 parent 4dd3505 commit 0af2f48

File tree

3 files changed

+112
-105
lines changed

3 files changed

+112
-105
lines changed

‎CONTRIBUTING-mentors.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing Guide for Mentors
2+
3+
To be a mentor go to [GSoC homepage][GSoC] and create your profile.
4+
If you need help, please check
5+
http://en.flossmanuals.net/melange/creating-and-editing/.
6+
7+
**After creating your profile, open an [issue][issues] requesting that your
8+
username be added at [organization-team.md][OT] or send a pull request with
9+
your addition.**
10+
11+
### Proposal summary (Mentors)
12+
13+
**Short Version**
14+
15+
If you have a proposal, please create an [issue][issues] for it.
16+
17+
**Long Version**
18+
19+
If you have a proposal,
20+
21+
1. copy `YYYY/ideas/skeleton.md` to `YYYY/ideas/title-of-my-proposal.md`
22+
where `YYYY` is the currently year
23+
and `title-of-my-proposal` is a sort version of the title of your proposal.
24+
2. add a link to `YYYY/ideas/title-of-my-proposal.md` at `YYYY/ideas-list.md`.
25+
3. send a pull request with the changes at `YYYY`.
26+
4. [create an issue](https://github.com/numfocus/gsoc/issues/new)
27+
where students can ask questions.
28+
29+
[GSoC]: https://www.google-melange.com/gsoc/homepage/google/gsoc2015
30+
[issues]: https://github.com/numfocus/gsoc/issues

‎CONTRIBUTING-students.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing Guide for Students
2+
3+
Projects proposed by mentors are listed at our [ideas list][IL] and
4+
questions can be asked at [our issue tracker][issues].
5+
6+
You are welcome to propose your own project. If you wish to do so, please
7+
open an issue to discuss your proposal and/or send a pull request with it.
8+
9+
If you choose to propose your own project idea you will need to find
10+
a mentor for the project. **Proposals without a mentor will not be
11+
considered.**
12+
13+
### Proposal draft
14+
15+
1. Fork https://github.com/numfocus/gsoc
16+
17+
2. Clone your fork:
18+
19+
~~~
20+
$ git clone https://github.com/username/gsoc2015.git
21+
~~~
22+
23+
where `username` is your GitHub username.
24+
25+
In my case is `r-gaia-cs`, so I will use
26+
27+
~~~
28+
$ git clone https://github.com/r-gaia-cs/gsoc.git
29+
~~~
30+
31+
2. Copy `YYYY/proposals/skeleton.md` to `YYYY/proposals/your-name.md`
32+
where `YYYY` is the currently year, `your` is your last name, all lowercase,
33+
and `name` is your firts name, all lowercase.
34+
35+
For example, my name is Raniere Silva so I need to
36+
copy `YYYY/proposals/skeleton.md` to `YYYY/proposals/silva-raniere.md`.
37+
38+
3. Edit `YYYY/proposals/your-name.md` filling all sections.
39+
40+
If you need you can create new sections.
41+
42+
The text in a few sections are reminders for you
43+
when writing your proposal.
44+
45+
4. Commit your changes:
46+
47+
~~~
48+
$ git add proposals
49+
$ git commit
50+
~~~
51+
52+
5. Update it to GitHub:
53+
54+
~~~
55+
$ git push origin master
56+
~~~
57+
58+
6. Create a pull request.
59+
60+
7. Edit `YYYY/proposals/your-name.md` to address the comments.
61+
62+
8. Update your pull request:
63+
64+
~~~
65+
$ git commit -a
66+
$ git push origin master
67+
~~~
68+
69+
9. Back to step 7.
70+
71+
### Final Proposal
72+
73+
Your final proposal must be submitted to [GSoC][]
74+
**before March 27th 19:00 UTC**.
75+
76+
[IL]: 2015/ideas-list.md
77+
[issues]: https://github.com/numfocus/gsoc/issues

‎CONTRIBUTING.md

Lines changed: 5 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,9 @@
11
# Contributing
22

3-
## Mentors
3+
Please check
44

5-
To be a mentor go to [GSoC homepage][GSoC] and create your profile.
6-
If you need help, please check
7-
http://en.flossmanuals.net/melange/creating-and-editing/.
5+
- [Contributing Guide for Students][CS]
6+
- [Contributing Guide for Mentors][CM]
87

9-
**After creating your profile, open an [issue][issues] requesting that your
10-
username be added at [organization-team.md][OT] or send a pull request with
11-
your addition.**
12-
13-
### Proposal summary (Mentors)
14-
15-
**Short Version**
16-
17-
If you have a proposal, please create an [issue][issues] for it.
18-
19-
**Long Version**
20-
21-
If you have a proposal,
22-
23-
1. copy `YYYY/ideas/skeleton.md` to `YYYY/ideas/title-of-my-proposal.md`
24-
where `YYYY` is the currently year
25-
and `title-of-my-proposal` is a sort version of the title of your proposal.
26-
2. add a link to `YYYY/ideas/title-of-my-proposal.md` at `YYYY/ideas-list.md`.
27-
3. send a pull request with the changes at `YYYY`.
28-
4. [create an issue](https://github.com/numfocus/gsoc/issues/new)
29-
where students can ask questions.
30-
31-
## Students
32-
33-
Projects proposed by mentors are listed at our [ideas list][IL] and
34-
questions can be asked at [our issue tracker][issues].
35-
36-
You are welcome to propose your own project. If you wish to do so, please
37-
open an issue to discuss your proposal and/or send a pull request with it.
38-
39-
If you choose to propose your own project idea you will need to find
40-
a mentor for the project. **Proposals without a mentor will not be
41-
considered.**
42-
43-
### Proposal draft
44-
45-
1. Fork https://github.com/numfocus/gsoc
46-
47-
2. Clone your fork:
48-
49-
~~~
50-
$ git clone https://github.com/username/gsoc2015.git
51-
~~~
52-
53-
where `username` is your GitHub username.
54-
55-
In my case is `r-gaia-cs`, so I will use
56-
57-
~~~
58-
$ git clone https://github.com/r-gaia-cs/gsoc.git
59-
~~~
60-
61-
2. Copy `YYYY/proposals/skeleton.md` to `YYYY/proposals/your-name.md`
62-
where `YYYY` is the currently year, `your` is your last name, all lowercase,
63-
and `name` is your firts name, all lowercase.
64-
65-
For example, my name is Raniere Silva so I need to
66-
copy `YYYY/proposals/skeleton.md` to `YYYY/proposals/silva-raniere.md`.
67-
68-
3. Edit `YYYY/proposals/your-name.md` filling all sections.
69-
70-
If you need you can create new sections.
71-
72-
The text in a few sections are reminders for you
73-
when writing your proposal.
74-
75-
4. Commit your changes:
76-
77-
~~~
78-
$ git add proposals
79-
$ git commit
80-
~~~
81-
82-
5. Update it to GitHub:
83-
84-
~~~
85-
$ git push origin master
86-
~~~
87-
88-
6. Create a pull request.
89-
90-
7. Edit `YYYY/proposals/your-name.md` to address the comments.
91-
92-
8. Update your pull request:
93-
94-
~~~
95-
$ git commit -a
96-
$ git push origin master
97-
~~~
98-
99-
9. Back to step 7.
100-
101-
### Final Proposal
102-
103-
Your final proposal must be submitted to [GSoC][]
104-
**before March 27th 19:00 UTC**.
105-
106-
[GSoC]: https://www.google-melange.com/gsoc/homepage/google/gsoc2015
107-
[IL]: 2015/ideas-list.md
108-
[OT]: organization-team.md
109-
[issues]: https://github.com/numfocus/gsoc/issues
8+
[CM]: CONTRIBUTING-mentros.md
9+
[CS]: CONTRIBUTING-students.md

0 commit comments

Comments
 (0)