Skip to content

Commit 5468014

Browse files
[DOC] Contributor docs update (#2554)
* contributing docs update * contributing docs update 2 * typos * Update contributing.md new section * Update testing.md testing update * Update contributing.md dont steal code * Automatic `pre-commit` fixes * Update contributing.md if --------- Co-authored-by: MatthewMiddlehurst <25731235+MatthewMiddlehurst@users.noreply.github.com> Co-authored-by: Antoine Guillaume <antoine.guillaume45@gmail.com>
1 parent f535412 commit 5468014

File tree

3 files changed

+34
-5
lines changed

3 files changed

+34
-5
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ not applicable. To check a box, replace the space inside the square brackets wit
5151
-->
5252

5353
##### For all contributions
54-
- [ ] I've added myself to the [list of contributors](https://github.com/aeon-toolkit/aeon/blob/main/.all-contributorsrc). Alternatively, you can use the [@all-contributors](https://allcontributors.org/docs/en/bot/usage) bot to do this for you after the PR has been merged.
54+
- [ ] I've added myself to the [list of contributors](https://github.com/aeon-toolkit/aeon/blob/main/.all-contributorsrc). Alternatively, you can use the [@all-contributors](https://allcontributors.org/docs/en/bot/usage) bot to do this for you **after** the PR has been merged.
5555
- [ ] The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.
5656

5757
##### For new estimators and functions

docs/contributing.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ kinds of contributions, not just code. Improvements to docs, bug reports, and ta
55
on communications or code of conduct responsibilities are all examples of valuable
66
contributions beyond code which help make `aeon` a great package.
77

8-
Please consider whether you will be able to tackle and issue or pull request before
8+
Please consider whether you will be able to tackle and issue or pull request (PR) before
99
assigning yourself to it. If the issue requires editing Python code, you should have
1010
some experience with Python and be able to run tests. If the issue tackles the
1111
specifics of a machine learning algorithm, some relevant knowledge of machine learning
@@ -14,9 +14,22 @@ of knowledge is required to make a meaningful contribution to certain issues.
1414
ChatGPT is not a replacement for this knowledge.
1515

1616
Pull requests from unknown contributors which do not attempt to resolve the issue being
17-
addressed, completely disregard the pull request template, or consist of low quality AI
17+
addressed, completely disregard the PR template, or consist of low quality AI
1818
generated output may be closed without review.
1919

20+
When implementing new algorithms, developers may require some benchmarking
21+
against alternative implementations or published results. This is likely to
22+
be the case for complex published algorithms which are not contributed by trusted
23+
developers or the original authors. A developer may eventually do this themselves if the
24+
contributor is unable to, but this is a time-consuming process and may delay the
25+
merging of the PR significantly. Please be aware of this when assigning
26+
yourself to an issue for such algorithms.
27+
28+
When using code from another package or writing code inspired from another implementation,
29+
please mention this in your PR. At the very least credit must be given where
30+
applicable. If the package has a different license, using the code as is may not be
31+
acceptable. Using others code without credit will like result in your PR being closed.
32+
2033
In the following we will give a brief overview of how to contribute to `aeon`. Making
2134
contributions to open-source projects takes a bit of proactivity and can be daunting at
2235
first, but members of the community are here to help and answer questions. If you get
@@ -36,7 +49,8 @@ list may be a good place to start.
3649
it. **First ensure that the issue is not already being worked on. Look if there are any
3750
linked PRs and search the issue number in the pull requests list.**
3851
To assign yourself an **Issue/Pull Request**, please post a comment in the issue
39-
including '@aeon-actions-bot', the username of people to assign and the word `assign`:
52+
including '@aeon-actions-bot', the username of people to assign and the word `assign`
53+
(Please note that anyone @'ed in the comment will be assigned to the issue):
4054

4155
For example:
4256
```python
@@ -58,6 +72,9 @@ be patient, as Core Developers are volunteers and may be busy with other tasks o
5872
outside the package. It could take a while to get a review during
5973
slow periods, so please do not rush to @ developers or repeatedly ask for a review.
6074
Consider opening the PR as a draft until it is ready for review and passing tests.
75+
7. Respond to reviews if applicable. If you disagree with a change, discuss with the reviewer
76+
Push code as required. Please avoid force-pushing code unless necessary, as this can make
77+
reviewing more difficult and interacts poorly with some CI elements.
6178
8. Once your PR is approved, it will be merged into the `aeon` repository. Thanks for
6279
making a contribution! Make sure you are included in the [list of contributors](contributors.md).
6380

@@ -83,6 +100,17 @@ Alternatively, you can use the [@all-contributors](https://allcontributors.org/d
83100
bot to do this for you. If the contribution is contained in a PR, please only @ the bot
84101
when the PR has been merged. A list of relevant tags can be found [here](https://allcontributors.org/docs/en/emoji-key).
85102

103+
## Joining `aeon` as a Core Developer
104+
105+
`aeon` Core Developers have write access to the repository and the ability to vote on
106+
community decisions. For more details on this role, please refer to the
107+
[about](about.md) and [governance](governance.md) pages.
108+
109+
If you would like to become a Core Developer, the best way is to reach out and express
110+
your interest. We are particularly open to dedicated contributors who have made
111+
high-quality contributions to the project, as well as time series researchers and
112+
industry professionals.
113+
86114
## Further Reading
87115

88116
For further information on contributing to `aeon`, please see the following pages.

docs/developer_guide/testing.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,8 @@ The `aeon` PR testing workflow runs on every PR to the main branch. By default,
166166
will run a constrained set of tests excluding some tests such as those which
167167
are noticeably expensive or prone to failure (i.e. I/O from external sources).
168168
The estimators run will also be split into smaller subsets to spread them over
169-
different Python version and operating system combinations. This is controlled by the
169+
different Python version and operating system combinations. This can result in failures
170+
in some runs (likely 3), while others pass without issue. This is controlled by the
170171
`PR_TESTING` flag in [`testing/testing_config.py`](https://github.com/aeon-toolkit/aeon/blob/main/aeon/testing/testing_config.py).
171172

172173
A large portion of testing time is spent compiling `numba` functions. By default,

0 commit comments

Comments
 (0)