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

Repository docs update #1193

Merged
merged 3 commits into from
Aug 8, 2023
Merged

Repository docs update #1193

merged 3 commits into from
Aug 8, 2023

Conversation

ClaudiaComito
Copy link
Contributor

Due Diligence

  • General:
    • base branch must be main for new features, latest release branch (e.g. release/1.3.x) for bug fixes
    • title of the PR is suitable to appear in the Release Notes
  • Implementation:
    • unit tests: all split configurations tested
    • unit tests: multiple dtypes tested
    • documentation updated where needed

Description

Small updates to contributing and quick_start.

I propose an incremental update to our repo documentation, merging even small changes as soon as they are ready. DO NOT DELETE THIS BRANCH after merging, we'll still use it.

We'll track changes in #1186

Changes proposed:

  • Notes on automated branch creation in contributing.md and quick_start.md

Type of change

  • Documentation update

Memory requirements

NA

Performance

NA

Does this change modify the behaviour of other functions? If so, which?

no

@ClaudiaComito ClaudiaComito added the documentation Anything related to documentation label Aug 7, 2023
@ClaudiaComito ClaudiaComito added this to the Repo Clean-Up milestone Aug 7, 2023
@ghost
Copy link

ghost commented Aug 7, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@github-actions
Copy link
Contributor

github-actions bot commented Aug 7, 2023

Thank you for the PR!

@github-actions
Copy link
Contributor

github-actions bot commented Aug 7, 2023

Thank you for the PR!

@codecov
Copy link

codecov bot commented Aug 7, 2023

Codecov Report

Merging #1193 (fcb5f82) into main (f9d1919) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1193   +/-   ##
=======================================
  Coverage   92.16%   92.16%           
=======================================
  Files          75       75           
  Lines       10705    10705           
=======================================
  Hits         9866     9866           
  Misses        839      839           
Flag Coverage Δ
unit 92.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Sai-Suraj-27
Copy link
Collaborator

@ClaudiaComito mam, the changes look fine👍.
My actual GitHub account is this, you requested review from my old/un-used account.

@ClaudiaComito ClaudiaComito removed the request for review from saisuraj27-729 August 7, 2023 17:01
Copy link
Collaborator

@mrfh92 mrfh92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me. Thanks 👍

Copy link
Member

@JuanPedroGHM JuanPedroGHM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great.

@ClaudiaComito
Copy link
Contributor Author

Thanks everybody. @Sai-Suraj-27 thanks, sorry about this, you should be contributing with your new account now.

@ClaudiaComito ClaudiaComito merged commit 3649f9c into main Aug 8, 2023
79 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants