File tree Expand file tree Collapse file tree 2 files changed +26
-2
lines changed
Expand file tree Collapse file tree 2 files changed +26
-2
lines changed Original file line number Diff line number Diff line change @@ -6,7 +6,10 @@ read [how the system works first](../home/how_it_works.md) before proceeding.
66
77## Set Up for Development
88
9- 1 . Fork the [ Ephys Link repository] ( https://github.com/VirtualBrainLab/ephys-link ) .
9+ 1 . Fork the [ Ephys Link repository] ( https://github.com/VirtualBrainLab/ephys-link ) . If you're new to contributing, we
10+ recommend
11+ reading [ this guide] ( https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project )
12+ by GitHub.
10132 . Follow the instructions for [ installing Ephys Link for development] ( index.md#installing-for-development ) to get all
1114 the necessary dependencies and tools set up. In this case, you'll want to clone your fork.
12153 . (Optional) Familiarize yourself with the [ repo's organization] ( code_organization.md ) .
Original file line number Diff line number Diff line change @@ -26,4 +26,25 @@ package in editable mode.
2626
2727If you encounter any dependency issues (particularly with ` aiohttp ` ), try installing the latest Microsoft Visual C++
2828(MSVC v143+ x86/64) and the Windows SDK (10/11)
29- via [ Visual Studio Build Tools Installer] ( https://visualstudio.microsoft.com/visual-cpp-build-tools/ ) .
29+ via [ Visual Studio Build Tools Installer] ( https://visualstudio.microsoft.com/visual-cpp-build-tools/ ) .
30+
31+ ## Contributing Code
32+
33+ We recommend first time contributors to
34+ read [ this guide] ( https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project ) by
35+ GitHub to understand how to contribute changes.
36+
37+ ## Deploying New Releases
38+
39+ !!! note
40+
41+ Only VBL members can make official releases.
42+
43+ There is a [ GitHub action] ( https://github.com/VirtualBrainLab/ephys-link/actions/workflows/release.yml ) configured to
44+ build and publish Ephys Link as a standalone EXE and as a PyPI package. The trigger is to make and push a new tag.
45+
46+ ``` bash
47+ git switch main
48+ git tag v2.0.0
49+ git push origin --tags
50+ ```
You can’t perform that action at this time.
0 commit comments