Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

add wwzeng1 as a contributor for bug #846

Merged
merged 2 commits into from
Oct 16, 2023

Conversation

allcontributors[bot]
Copy link
Contributor

Adds @wwzeng1 as a contributor for bug.

This was requested by MatthewMiddlehurst in this comment

@github-actions
Copy link
Contributor

Thank you for contributing to aeon!

I did not find any labels to add based on the title. Please add the ENH, MNT, BUG, DOC and/or GOV tag to your pull requests titles. For now you can add the labels manually.

The "Checks" tab above or the panel below will show the status of our automated tests. From the panel below you can click on "Details" to the right of the check 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.

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

@sweep-ai
Copy link
Contributor

sweep-ai bot commented Oct 16, 2023

Apply Sweep Rules to your PR?

  • Apply: There should not be large chunks of code that are just commented out. Docstrings and explanations in code are okay though.
  • Apply: Any clearly inefficient or redundant code can be optimized or refactored. Any improvements should not change the functionality of the code.
  • Apply: All public classes and functions should have a numpydoc style docstring. This should include a description of the class or function, the parameters, the class attributes or function return values, and a usage example for the class or function.
  • Apply: Update the relevant API page in 'docs/api_reference/' when new public functions and classes are added and not included in the API documentation. For example, if a new function is added to 'aeon/distances/', a sphinx.ext.autosummary link should also be added to 'docs/api_reference/distances.rst'. New sections in the page should not be created for individual functions and classes, add it to the most relevant existing one. Only add functions and classes which are not already in the relevant API page and avoid duplicate entries.
  • Apply: We use unit tests for our code. If we have 'class.py', there can be a 'tests/test_class.py' relative to the directory of the file. It is not necessary to create a test file for each new class and function, but any file specific tests should be in similarly named file.

@MatthewMiddlehurst MatthewMiddlehurst added documentation Improvements or additions to documentation no changelog PR should not be added to the changelog labels Oct 16, 2023
@MatthewMiddlehurst MatthewMiddlehurst merged commit 560a813 into main Oct 16, 2023
2 checks passed
@MatthewMiddlehurst MatthewMiddlehurst deleted the all-contributors/add-wwzeng1 branch October 16, 2023 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation no changelog PR should not be added to the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant