You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-8Lines changed: 21 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,25 +25,35 @@ These are especially suitable if you're new to the project, and we recommend sta
25
25
26
26
## Contributing code
27
27
28
-
### Creating a development environment
28
+
### Forking the repository
29
+
30
+
If you want to contribute to someone else's project but don’t have permission to make changes directly, you can create your own copy of the project, make updates, and then suggest those updates for inclusion in the main project. This process is often called a "fork and pull request" workflow.
29
31
30
-
In order to make changes to `movement`, you will need to fork the [repository](movement-github:).
31
32
If you are not familiar with `git`, we recommend reading up on [this guide](https://docs.github.com/en/get-started/using-git/about-git#basic-git-commands).
32
33
33
-
1. Clone the forked repository to your local machine and change directory:
34
+
1. Fork the repository on GitHub.
35
+
In order to make changes to `movement`, you will need to fork the [repository](movement-github:). When you create your own copy (or "fork") of a project, it’s like making a new workspace that shares code with the original project. This is useful for open-source projects or anytime you don’t have write access to the original project.
36
+
[Read more about forking in the GitHub docs](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
37
+
38
+
2. Clone your fork to your local machine and change directory:
3. Create an environment using [conda](conda:) or [uv](uv:getting-started/installation/) and install `movement`in editable mode, including development dependencies.
52
+
### Creating a development environment
53
+
54
+
Now that you have the repository locally, you need to set up a Python environment and install the project dependencies.
55
+
56
+
1. Create an environment using [conda](conda:) or [uv](uv:getting-started/installation/) and install `movement`in editable mode, including development dependencies.
47
57
48
58
::::{tab-set}
49
59
@@ -81,7 +91,7 @@ If you are not familiar with `git`, we recommend reading up on [this guide](http
81
91
82
92
::::
83
93
84
-
4. Finally, initialise the [pre-commit hooks](#formatting-and-pre-commit-hooks):
94
+
2. Finally, initialise the [pre-commit hooks](#formatting-and-pre-commit-hooks):
85
95
86
96
```sh
87
97
pre-commit install
@@ -108,6 +118,9 @@ A typical PR workflow would be:
108
118
* You may also run the pre-commit hooks manually, at any time, with `pre-commit run -a`.
109
119
* Make sure to write tests for any new features or bug fixes. See [testing](#testing) below.
110
120
* Don't forget to update the documentation, if necessary. See [contributing documentation](#contributing-documentation) below.
121
+
* Push your changes to your fork on GitHub(`git push origin <branch-name>`).
122
+
* Open a draft pull request from your fork to the upstream `movement` repository.
123
+
* **Note:** When creating the PR, ensure the base repository is `neuroinformatics-unit/movement` (the upstream) and the head repository is your fork. GitHub sometimes defaults to comparing against your own fork.
111
124
* Push your changes to GitHub and open a draft pull request, with a meaningful title and a thorough description of the changes.
112
125
* If all checks (e.g. linting, type checking, testing) run successfully, you may mark the pull request as ready for review.
113
126
* Respond to review comments and implement any requested changes.
0 commit comments