Skip to content

Commit e67ba7d

Browse files
naveedishaquenaveedishaque
authored
Update README.md
1 parent c8edf20 commit e67ba7d

File tree

1 file changed

+157
-178
lines changed

1 file changed

+157
-178
lines changed

‎README.md

+157-178
Original file line numberDiff line numberDiff line change
@@ -8,188 +8,167 @@ This repository contains some templates and examples of how to implement your mo
88
- methods: BayesSpace and SpaGCN
99
- evaluation metrics: ARI and V
1010

11-
### How to contribute a module
11+
## Contributing and Code of Conduct
1212

13-
Module contribution will be managed via GitHub. The steps to contribute a module are:
14-
1. Create or claim a **GitHub issue** from the [SpaceHack issue board.](https://github.com/SpatialHackathon/SpaceHack2023/issues) that describes the module you want to implement. There are currently 90 issues to claim, but if you come up with a new idea, please **create** a new issue, add the appropriate **tags**, and **assign** the task to yourself.
15-
2. Add **metadata** to our metadata [spreadsheet](https://docs.google.com/spreadsheets/d/1QCeAF4yQG4bhZSGPQwwVBj_XF7ADY_2mK5xivAIfHsc/edit). Please fill in as much as you can as metadata is helpful! If you feel the need, please also add new columns or add additional notes. The metadata should be added to the appropriate tabs:
16-
- [datasets](https://docs.google.com/spreadsheets/d/1QCeAF4yQG4bhZSGPQwwVBj_XF7ADY_2mK5xivAIfHsc/edit#gid=1453488771)
17-
- [computational methods](https://docs.google.com/spreadsheets/d/1QCeAF4yQG4bhZSGPQwwVBj_XF7ADY_2mK5xivAIfHsc/edit#gid=0)
18-
- [evaluation metrics](https://docs.google.com/spreadsheets/d/1QCeAF4yQG4bhZSGPQwwVBj_XF7ADY_2mK5xivAIfHsc/edit#gid=4776337)
19-
- [simulations and technical evaluation](https://docs.google.com/spreadsheets/d/1QCeAF4yQG4bhZSGPQwwVBj_XF7ADY_2mK5xivAIfHsc/edit#gid=640974611)
20-
3. Now you are ready to create a new git **[branch](https://learngitbranching.js.org/)**. Try to give your new branch an intuitive prefix such as `data_...`, `method_...` or `metric_..`. You can create a new branch in several ways: (i) [create a branch directly from the issue board](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue) and then `git checkout` that branch, or (ii) via the command line:
21-
```
22-
# clone the template repository
23-
git clone https://github.com/SpatialHackathon/SpaceHack2023.git
24-
# create and switch to a new branch for your e.g. method "X"
25-
git branch method_x_naveedishaque # try to make the branch name unique!
26-
git checkout method_x_naveedishaque
27-
# link the branch to the issue via the issue board: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
28-
```
29-
4. Modify the files, filenames, and code in `template/`, referring to the examples in the `data`, `method`, or `metric` subfolder. If your method requires a specific type or preprocessing, please reach out to the organisers!
30-
5. Test. We are currently working on validators and automatic testing scripts... but this is tricky. Reach out to Niklas Muller-Botticher when you are ready to test!
31-
6. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request?tool=cli)
32-
7. Code review (by whom?) and merge your contributed module into the GitHub main branch!
13+
Read our [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md).
3314

34-
Easy!
15+
## Contributors
3516

36-
### Contributors
37-
38-
<!-- readme: contributors -start -->
39-
<table>
40-
<tbody>
41-
<tr>
42-
<td align="center">
43-
<a href="https://github.com/Jieran-S">
44-
<img src="https://avatars.githubusercontent.com/u/91852421?v=4" width="75;" alt="Jieran-S"/>
45-
<br />
46-
<sub><b>Jieran S.</b></sub>
47-
</a>
48-
</td>
49-
<td align="center">
50-
<a href="https://github.com/shdam">
51-
<img src="https://avatars.githubusercontent.com/u/49019552?v=4" width="75;" alt="shdam"/>
52-
<br />
53-
<sub><b>Søren Helweg Dam</b></sub>
54-
</a>
55-
</td>
56-
<td align="center">
57-
<a href="https://github.com/niklasmueboe">
58-
<img src="https://avatars.githubusercontent.com/u/42138117?v=4" width="75;" alt="niklasmueboe"/>
59-
<br />
60-
<sub><b>niklasmueboe</b></sub>
61-
</a>
62-
</td>
63-
<td align="center">
64-
<a href="https://github.com/peicai">
65-
<img src="https://avatars.githubusercontent.com/u/55488976?v=4" width="75;" alt="peicai"/>
66-
<br />
67-
<sub><b>peicai</b></sub>
68-
</a>
69-
</td>
70-
<td align="center">
71-
<a href="https://github.com/kbiharie">
72-
<img src="https://avatars.githubusercontent.com/u/33690856?v=4" width="75;" alt="kbiharie"/>
73-
<br />
74-
<sub><b>kbiharie</b></sub>
75-
</a>
76-
</td>
77-
<td align="center">
78-
<a href="https://github.com/heylf">
79-
<img src="https://avatars.githubusercontent.com/u/8162688?v=4" width="75;" alt="heylf"/>
80-
<br />
81-
<sub><b>heylf</b></sub>
82-
</a>
83-
</td>
84-
</tr>
85-
<tr>
86-
<td align="center">
87-
<a href="https://github.com/pakiessling">
88-
<img src="https://avatars.githubusercontent.com/u/104848590?v=4" width="75;" alt="pakiessling"/>
89-
<br />
90-
<sub><b>pakiessling</b></sub>
91-
</a>
92-
</td>
93-
<td align="center">
94-
<a href="https://github.com/Qirongmao97">
95-
<img src="https://avatars.githubusercontent.com/u/57286623?v=4" width="75;" alt="Qirongmao97"/>
96-
<br />
97-
<sub><b>Qirong Mao</b></sub>
98-
</a>
99-
</td>
100-
<td align="center">
101-
<a href="https://github.com/naveedishaque">
102-
<img src="https://avatars.githubusercontent.com/u/114547?v=4" width="75;" alt="naveedishaque"/>
103-
<br />
104-
<sub><b>Nav</b></sub>
105-
</a>
106-
</td>
107-
<td align="center">
108-
<a href="https://github.com/zsfrbkv">
109-
<img src="https://avatars.githubusercontent.com/u/43470646?v=4" width="75;" alt="zsfrbkv"/>
110-
<br />
111-
<sub><b>zaira seferbekova</b></sub>
112-
</a>
113-
</td>
114-
<td align="center">
115-
<a href="https://github.com/markrobinsonuzh">
116-
<img src="https://avatars.githubusercontent.com/u/6471769?v=4" width="75;" alt="markrobinsonuzh"/>
117-
<br />
118-
<sub><b>Mark Robinson</b></sub>
119-
</a>
120-
</td>
121-
<td align="center">
122-
<a href="https://github.com/sebastiantiesmeyer">
123-
<img src="https://avatars.githubusercontent.com/u/25506428?v=4" width="75;" alt="sebastiantiesmeyer"/>
124-
<br />
125-
<sub><b>sebastiantiesmeyer</b></sub>
126-
</a>
127-
</td>
128-
</tr>
129-
<tr>
130-
<td align="center">
131-
<a href="https://github.com/theinvisibleliya">
132-
<img src="https://avatars.githubusercontent.com/u/79532622?v=4" width="75;" alt="theinvisibleliya"/>
133-
<br />
134-
<sub><b>Liya Zaygerman</b></sub>
135-
</a>
136-
</td>
137-
<td align="center">
138-
<a href="https://github.com/meghanaturner">
139-
<img src="https://avatars.githubusercontent.com/u/22036504?v=4" width="75;" alt="meghanaturner"/>
140-
<br />
141-
<sub><b>Meghan Turner</b></sub>
142-
</a>
143-
</td>
144-
<td align="center">
145-
<a href="https://github.com/Aokht17">
146-
<img src="https://avatars.githubusercontent.com/u/56379827?v=4" width="75;" alt="Aokht17"/>
147-
<br />
148-
<sub><b>Anastasiia Okhtienko</b></sub>
149-
</a>
150-
</td>
151-
<td align="center">
152-
<a href="https://github.com/berl">
153-
<img src="https://avatars.githubusercontent.com/u/6773896?v=4" width="75;" alt="berl"/>
154-
<br />
155-
<sub><b>Brian Long</b></sub>
156-
</a>
157-
</td>
158-
<td align="center">
159-
<a href="https://github.com/gmoranzoni">
160-
<img src="https://avatars.githubusercontent.com/u/59561270?v=4" width="75;" alt="gmoranzoni"/>
161-
<br />
162-
<sub><b>Giorgia Moranzoni</b></sub>
163-
</a>
164-
</td>
165-
<td align="center">
166-
<a href="https://github.com/tmchartrand">
167-
<img src="https://avatars.githubusercontent.com/u/12821536?v=4" width="75;" alt="tmchartrand"/>
168-
<br />
169-
<sub><b>Tom Chartrand</b></sub>
170-
</a>
171-
</td>
172-
</tr>
173-
<tr>
174-
<td align="center">
175-
<a href="https://github.com/alam-shahul">
176-
<img src="https://avatars.githubusercontent.com/u/22669932?v=4" width="75;" alt="alam-shahul"/>
177-
<br />
178-
<sub><b>alam-shahul</b></sub>
179-
</a>
180-
</td>
181-
<td align="center">
182-
<a href="https://github.com/svedziok">
183-
<img src="https://avatars.githubusercontent.com/u/17719296?v=4" width="75;" alt="svedziok"/>
184-
<br />
185-
<sub><b>Sven Twardziok</b></sub>
186-
</a>
187-
</td>
188-
</tr>
189-
<tbody>
190-
</table>
17+
<!-- readme: contributors -start -->
18+
<table>
19+
<tbody>
20+
<tr>
21+
<td align="center">
22+
<a href="https://github.com/Jieran-S">
23+
<img src="https://avatars.githubusercontent.com/u/91852421?v=4" width="75;" alt="Jieran-S"/>
24+
<br />
25+
<sub><b>Jieran S.</b></sub>
26+
</a>
27+
</td>
28+
<td align="center">
29+
<a href="https://github.com/shdam">
30+
<img src="https://avatars.githubusercontent.com/u/49019552?v=4" width="75;" alt="shdam"/>
31+
<br />
32+
<sub><b>Søren Helweg Dam</b></sub>
33+
</a>
34+
</td>
35+
<td align="center">
36+
<a href="https://github.com/niklasmueboe">
37+
<img src="https://avatars.githubusercontent.com/u/42138117?v=4" width="75;" alt="niklasmueboe"/>
38+
<br />
39+
<sub><b>niklasmueboe</b></sub>
40+
</a>
41+
</td>
42+
<td align="center">
43+
<a href="https://github.com/peicai">
44+
<img src="https://avatars.githubusercontent.com/u/55488976?v=4" width="75;" alt="peicai"/>
45+
<br />
46+
<sub><b>peicai</b></sub>
47+
</a>
48+
</td>
49+
<td align="center">
50+
<a href="https://github.com/kbiharie">
51+
<img src="https://avatars.githubusercontent.com/u/33690856?v=4" width="75;" alt="kbiharie"/>
52+
<br />
53+
<sub><b>kbiharie</b></sub>
54+
</a>
55+
</td>
56+
<td align="center">
57+
<a href="https://github.com/heylf">
58+
<img src="https://avatars.githubusercontent.com/u/8162688?v=4" width="75;" alt="heylf"/>
59+
<br />
60+
<sub><b>heylf</b></sub>
61+
</a>
62+
</td>
63+
</tr>
64+
<tr>
65+
<td align="center">
66+
<a href="https://github.com/pakiessling">
67+
<img src="https://avatars.githubusercontent.com/u/104848590?v=4" width="75;" alt="pakiessling"/>
68+
<br />
69+
<sub><b>pakiessling</b></sub>
70+
</a>
71+
</td>
72+
<td align="center">
73+
<a href="https://github.com/Qirongmao97">
74+
<img src="https://avatars.githubusercontent.com/u/57286623?v=4" width="75;" alt="Qirongmao97"/>
75+
<br />
76+
<sub><b>Qirong Mao</b></sub>
77+
</a>
78+
</td>
79+
<td align="center">
80+
<a href="https://github.com/naveedishaque">
81+
<img src="https://avatars.githubusercontent.com/u/114547?v=4" width="75;" alt="naveedishaque"/>
82+
<br />
83+
<sub><b>Nav</b></sub>
84+
</a>
85+
</td>
86+
<td align="center">
87+
<a href="https://github.com/zsfrbkv">
88+
<img src="https://avatars.githubusercontent.com/u/43470646?v=4" width="75;" alt="zsfrbkv"/>
89+
<br />
90+
<sub><b>zaira seferbekova</b></sub>
91+
</a>
92+
</td>
93+
<td align="center">
94+
<a href="https://github.com/markrobinsonuzh">
95+
<img src="https://avatars.githubusercontent.com/u/6471769?v=4" width="75;" alt="markrobinsonuzh"/>
96+
<br />
97+
<sub><b>Mark Robinson</b></sub>
98+
</a>
99+
</td>
100+
<td align="center">
101+
<a href="https://github.com/sebastiantiesmeyer">
102+
<img src="https://avatars.githubusercontent.com/u/25506428?v=4" width="75;" alt="sebastiantiesmeyer"/>
103+
<br />
104+
<sub><b>sebastiantiesmeyer</b></sub>
105+
</a>
106+
</td>
107+
</tr>
108+
<tr>
109+
<td align="center">
110+
<a href="https://github.com/theinvisibleliya">
111+
<img src="https://avatars.githubusercontent.com/u/79532622?v=4" width="75;" alt="theinvisibleliya"/>
112+
<br />
113+
<sub><b>Liya Zaygerman</b></sub>
114+
</a>
115+
</td>
116+
<td align="center">
117+
<a href="https://github.com/meghanaturner">
118+
<img src="https://avatars.githubusercontent.com/u/22036504?v=4" width="75;" alt="meghanaturner"/>
119+
<br />
120+
<sub><b>Meghan Turner</b></sub>
121+
</a>
122+
</td>
123+
<td align="center">
124+
<a href="https://github.com/Aokht17">
125+
<img src="https://avatars.githubusercontent.com/u/56379827?v=4" width="75;" alt="Aokht17"/>
126+
<br />
127+
<sub><b>Anastasiia Okhtienko</b></sub>
128+
</a>
129+
</td>
130+
<td align="center">
131+
<a href="https://github.com/berl">
132+
<img src="https://avatars.githubusercontent.com/u/6773896?v=4" width="75;" alt="berl"/>
133+
<br />
134+
<sub><b>Brian Long</b></sub>
135+
</a>
136+
</td>
137+
<td align="center">
138+
<a href="https://github.com/gmoranzoni">
139+
<img src="https://avatars.githubusercontent.com/u/59561270?v=4" width="75;" alt="gmoranzoni"/>
140+
<br />
141+
<sub><b>Giorgia Moranzoni</b></sub>
142+
</a>
143+
</td>
144+
<td align="center">
145+
<a href="https://github.com/tmchartrand">
146+
<img src="https://avatars.githubusercontent.com/u/12821536?v=4" width="75;" alt="tmchartrand"/>
147+
<br />
148+
<sub><b>Tom Chartrand</b></sub>
149+
</a>
150+
</td>
151+
</tr>
152+
<tr>
153+
<td align="center">
154+
<a href="https://github.com/alam-shahul">
155+
<img src="https://avatars.githubusercontent.com/u/22669932?v=4" width="75;" alt="alam-shahul"/>
156+
<br />
157+
<sub><b>alam-shahul</b></sub>
158+
</a>
159+
</td>
160+
<td align="center">
161+
<a href="https://github.com/svedziok">
162+
<img src="https://avatars.githubusercontent.com/u/17719296?v=4" width="75;" alt="svedziok"/>
163+
<br />
164+
<sub><b>Sven Twardziok</b></sub>
165+
</a>
166+
</td>
167+
</tr>
168+
<tbody>
169+
</table>
191170
<!-- readme: contributors -end -->
192171

193-
### License
172+
## License
194173

195174
We have adopted the "MIT No Attribution" (MIT-0) License. It is currently attributed to the "SpaceHack organizers", but please also make sure to add your name to your contributions. More on MIT-0 [here](https://github.com/aws/mit-0)

0 commit comments

Comments
 (0)