Skip to content

Commit 0079926

Browse files
committed
removes redudant files as requestesd by @adamltyson and moves relevant parts on how to contribute to main README #510
1 parent 67d59f2 commit 0079926

File tree

3 files changed

+15
-185
lines changed

3 files changed

+15
-185
lines changed

CODE_OF_CONDUCT.md

-76
This file was deleted.

CONTRIBUTING.md

-108
This file was deleted.

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,21 @@ pytest -vs tests/
178178

179179
## Contributions
180180
### How to contribute
181-
Refer to the [CONTRIBUTION.md](CONTRIBUTION.md) guideline for this repository. For more details, please check the [Brain Glove Developer’s Guide.](https://brainglobe.info/community/developers/index.html)
181+
1. Fork this repo
182+
2. Generate your SSH keys as suggested [here](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
183+
3. (Optional) setup you commit signature verification as shown [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#ssh-commit-signature-verification)
184+
4. Clone the repository by typing (or copying) the following lines in a terminal
185+
```bash
186+
git clone [email protected]:brainglobe/brainglobe-atlasapi.git
187+
```
188+
5. Install conda or uv in your operative system of your machine.
189+
6. Install an editable version of the package; by running 'pip install -e ".[dev]"' within the cloned directory
190+
7. Create an issue and branch (as showing in the fellowing section)
191+
8. Create a script to package your atlas, and place into 'brainglobe_atlasapi/atlas_generation/atlas_scripts'. Please see other scripts for examples.
192+
8.1 Your script should contain everything required to run.
193+
8.2 The raw data should be hosted on a publicly accessible repository so that anyone can run the script to recreate the atlas.
194+
195+
For more details, please check the [Brain Glove Developer’s Guide.](https://brainglobe.info/community/developers/index.html)
182196

183197
### Seeking help or contributing
184198
We are always happy to help users of our tools, and welcome any contributions. If you would like to get in contact with us for any reason, please see the [contact page of our website](https://brainglobe.info/contact.html).

0 commit comments

Comments
 (0)