Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[DOC] Contributing readme and other contributing updates #2445

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

MatthewMiddlehurst
Copy link
Member

Puts the contributing docs on the front page since we are getting more new contributors.

Adds a request to not @ developers for reviews immediately.

@MatthewMiddlehurst MatthewMiddlehurst requested a review from a team as a code owner December 12, 2024 12:27
@aeon-actions-bot aeon-actions-bot bot added the documentation Improvements or additions to documentation label Dec 12, 2024
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
docs/contributing.md Outdated Show resolved Hide resolved
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants