Skip to content

Commit 0f918cb

Browse files
authored
[MRG] Add GSoC link to Contr page (#1234)
This also adds some instruction about "don't make duplicate PRs". Because GSoC is ramping up, I will self-merge this PR as soon as it passes the tests. I will then take the up-to-date "dev" version of the Contributing Guide page, and overwrite the "stable" documentation version of the same page. This way, the GSoC link will be on the primary, published Contributing page.
1 parent 1bc905b commit 0f918cb

File tree

1 file changed

+30
-12
lines changed

1 file changed

+30
-12
lines changed

doc/contributing.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,37 @@
33

44
Please read the contribution guide **until the end** before beginning contributions.
55

6-
Contributions are welcome in the form of Pull Requests. You must abide by our [Code of
6+
Contributions are welcome in the form of Pull Requests (PR's). You must abide by our [Code of
77
Conduct, found
8-
here](https://github.com/jonescompneurolab/hnn-core/blob/master/CODE_OF_CONDUCT.md), which includes instructions on what kind of AI- and LLM-generated code contributions we accept. Our
9-
{doc}`Governance Model can be found here <governance>`. Please tie your Pull Requests to specific Issues.
10-
11-
Once the implementation of a piece of functionality is considered to be bug free and
12-
properly documented (both API docs and an example script), it can be incorporated into
13-
the `master` branch, which is where our releases come from.
14-
15-
To contribute to `hnn-core` development, you need a special kind of installation, see the
16-
["`pip` Source Installation" section of our Installation Guide][] on our [Textbook website][]. Note that this is **different** from the "`pip` Package Installation" type on that webpage!
17-
18-
We are experimenting with having once-monthly HNN Development meetings which are open to the public. These take place on the first Monday of every month at 1:00 PM, United States Eastern time (the [timezone of Providence, RI, viewable here](https://www.timeanddate.com/worldclock/usa/providence)). You can access the Zoom room here [https://brown.zoom.us/j/99212200748](https://brown.zoom.us/j/99212200748). Note that there is a waiting room and you *must raise your hand* before you will be granted audio privileges. We reserve the right to kick out anyone causing disruptions during the meeting.
8+
here](https://github.com/jonescompneurolab/hnn-core/blob/master/CODE_OF_CONDUCT.md),
9+
which includes instructions on what kind of AI- and LLM-generated code contributions we
10+
accept. Our {doc}`Governance Model can be found here <governance>`.
11+
12+
Please **double-check that your new Pull Request does not accomplish the same task as
13+
any existing Pull Request**! We reserve the right to close any new PRs that are
14+
"duplicates" of work (and any PR in general). Please tie your Pull Requests to specific
15+
Issues. Once the implementation of a piece of functionality is considered to be bug free
16+
and properly documented (both API docs and possibly an example script), and we have
17+
reviewed it, we may merge it into the `master` branch, which is where our releases come
18+
from.
19+
20+
If you are interested in contributing to `hnn-core` as part of Google Summer of Code
21+
2026, [please see the Issue here for the latest
22+
information](https://github.com/jonescompneurolab/hnn-core/issues/1202).
23+
24+
To contribute to `hnn-core` development, you need a special kind of installation, see
25+
the ["`pip` Source Installation" section of our Installation Guide][] on our [Textbook
26+
website][]. Note that this is **different** from the "`pip` Package Installation" type
27+
on that webpage!
28+
29+
We are experimenting with having once-monthly HNN Development meetings which are open to
30+
the public. These take place on the first Monday of every month at 1:00 PM, United
31+
States Eastern time (the [timezone of Providence, RI, viewable
32+
here](https://www.timeanddate.com/worldclock/usa/providence)). You can access the Zoom
33+
room here
34+
[https://brown.zoom.us/j/99212200748](https://brown.zoom.us/j/99212200748). Note that
35+
there is a waiting room and you *must raise your hand* before you will be granted
36+
audio/video privileges. We will kick out anyone causing disruptions during the meeting.
1937

2038
## How to contribute code
2139

0 commit comments

Comments
 (0)