Skip to content

Commit ff7423f

Browse files
committed
Docs: restructure contributing guide and add community cards
1 parent 665412f commit ff7423f

File tree

2 files changed

+82
-8
lines changed

2 files changed

+82
-8
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,35 @@ These are especially suitable if you're new to the project, and we recommend sta
2525

2626
## Contributing code
2727

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.
2931

30-
In order to make changes to `movement`, you will need to fork the [repository](movement-github:).
3132
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).
3233

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:
3439

3540
```sh
36-
git clone https://github.com/<your-github-username>/movement.git
41+
git clone [https://github.com/](https://github.com/)<your-github-username>/movement.git
3742
cd movement
3843
```
3944

40-
2. Set the upstream remote to the base `movement` repository:
45+
3. Set the upstream remote to the base `movement` repository:
46+
This links your local copy to the original project so you can pull the latest changes.
4147

4248
```sh
43-
git remote add upstream https://github.com/neuroinformatics-unit/movement.git
49+
git remote add upstream [https://github.com/neuroinformatics-unit/movement.git](https://github.com/neuroinformatics-unit/movement.git)
4450
```
4551

46-
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.
4757

4858
::::{tab-set}
4959

@@ -81,7 +91,7 @@ If you are not familiar with `git`, we recommend reading up on [this guide](http
8191

8292
::::
8393

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):
8595

8696
```sh
8797
pre-commit install
@@ -108,6 +118,9 @@ A typical PR workflow would be:
108118
* You may also run the pre-commit hooks manually, at any time, with `pre-commit run -a`.
109119
* Make sure to write tests for any new features or bug fixes. See [testing](#testing) below.
110120
* 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.
111124
* Push your changes to GitHub and open a draft pull request, with a meaningful title and a thorough description of the changes.
112125
* If all checks (e.g. linting, type checking, testing) run successfully, you may mark the pull request as ready for review.
113126
* Respond to review comments and implement any requested changes.

docs/source/community/index.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,67 @@ developing a new feature, or improving the documentation—as long as you follow
99
To help you get started, we have prepared a statement on the project's [mission and scope](target-mission),
1010
a [roadmap](target-roadmaps) outlining our current priorities, and a detailed [contributing guide](target-contributing).
1111

12+
::::{grid} 1 1 2 2
13+
:gutter: 3
14+
15+
:::{grid-item-card} {fas}`users;sd-text-primary` People
16+
:link: people
17+
:link-type: doc
18+
19+
Meet the team, maintainers, and contributors behind the project.
20+
:::
21+
22+
:::{grid-item-card} {fas}`bullseye;sd-text-primary` Mission & Scope
23+
:link: mission-scope
24+
:link-type: doc
25+
26+
Understand the scientific goals and scope of the movement package.
27+
:::
28+
29+
:::{grid-item-card} {fas}`map-location-dot;sd-text-primary` Roadmaps
30+
:link: roadmaps
31+
:link-type: doc
32+
33+
Explore our future plans and development milestones.
34+
:::
35+
36+
:::{grid-item-card} {fas}`code-branch;sd-text-primary` How to Contribute
37+
:link: contributing
38+
:link-type: doc
39+
40+
Learn how to set up your environment and contribute code or documentation.
41+
:::
42+
43+
:::{grid-item-card} {fas}`chalkboard-user;sd-text-primary` Resources
44+
:link: resources
45+
:link-type: doc
46+
47+
Talks, slides, and other educational materials about movement.
48+
:::
49+
50+
:::{grid-item-card} {fas}`diagram-project;sd-text-primary` Related Projects
51+
:link: related-projects
52+
:link-type: doc
53+
54+
Discover other tools in the ecosystem and how they fit together.
55+
:::
56+
57+
:::{grid-item-card} {fas}`handshake;sd-text-primary` Code of Conduct
58+
:link: code-of-conduct
59+
:link-type: doc
60+
61+
Our pledge to foster an open and welcoming environment.
62+
:::
63+
64+
:::{grid-item-card} {fas}`scale-balanced;sd-text-primary` License
65+
:link: license
66+
:link-type: doc
67+
68+
BSD 3-Clause License information.
69+
:::
70+
71+
::::
72+
1273
(target-connect-with-us)=
1374
## Connect with us
1475
```{include} ../snippets/connect-with-us.md

0 commit comments

Comments
 (0)