Skip to content

Commit 9d16f34

Browse files
committed
Revised the contributiong section (fix #1)
1 parent 19e5826 commit 9d16f34

File tree

5 files changed

+28
-57
lines changed

5 files changed

+28
-57
lines changed

content/CONTRIBUTING.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

content/_toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ chapters:
77
- file: manifesto
88
- file: coc
99
- file: members
10-
- file: CONTRIBUTING
1110
- file: publications
11+
- file: contributing

content/contributing.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
This is a laboratory website maintained by the SIMEXP team. Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in the ways listed below.
4+
5+
## Improve the content
6+
7+
Fixing typos or suggestion changes to the text is very much appreciated. The layout can always be improved too! Whether you directly implement the changes or just make a general suggestion, do not hesitate to raise an issue.
8+
9+
## Add content
10+
11+
The SIMEXP website can always use more documentation on the laboratory operations. Any other idea is also welcome.
12+
13+
## Get Started
14+
15+
Ready to contribute? Here's how to set up `SIMEXP website` for local development.
16+
17+
1. Fork the repo on GitHub.
18+
2. Clone your fork locally.
19+
3. Install your local copy into a virtualenv, e.g., using `virtualenvwrapper` or `conda`.
20+
4. Create a branch for local development and make changes locally.
21+
5. Commit your changes and push your branch to GitHub.
22+
6. Submit a pull request through the GitHub website.
23+
24+
## Code of Conduct
25+
26+
Please note that the SIMEXP website project is released with a [Code of Conduct](coc.md). By contributing to this project you agree to abide by its terms.

content/images/brain_art.jpg

136 KB
Loading

content/manifesto.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Academia means different things to different people. The laboratory for brain si
55
## The hacker way
66
Sharing is a key aspect of all academic communities, but how that sharing works varies widely. Lots of academic collaborations are transactional in nature, with people exchanging one contribution for another. Original founders of free software and the hacker movement operate under very different, simple rules. If you want to learn about something, just ask and you can expect an answer. The day somebody wants to learn something from you, you are expected to help that person. Don’t try to balance out what you get and give to a particular person. By helping others, you’re just building up karma, doing good to your community and the world. A corollary of that collaborative ethos is to strive to openly share as much research material as possible, data, code and ideas. The sharing process is greatly facilitated by adopting tools designed for sharing in your daily research activities (“open by design”).
77

8+
![Brain art](images/brain_art.jpg)
89
## The brainhack way
910
Some laboratories operate under pretty strict labor division, with technical assistants helping researchers implement specific methods. SIMEXP works in data science, and our methods are computational. On one hand, relying on other people to implement computations dramatically limits both your ability to iterate quickly, and your understanding of the methods. On another hand, blind applications of algorithms to neural data without deep understanding of the neuroscience questions is not productive and is, in our typical use cases, a complete waste of time. A core SIMEXP belief is that lab members need to develop both strong computational and neuroscience skills, on top of their own area of expertise. This can be arduous at times, but is key for the type of research we do. It is also a huge asset for employability both inside and outside of academia.
1011

0 commit comments

Comments
 (0)