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

[INFRA] Guidelines for Document and Code contributions #4768

Closed
wants to merge 6 commits into from

Conversation

yaooqinn
Copy link
Member

@yaooqinn yaooqinn commented Apr 25, 2023

Why are the changes needed?

Guidelines for Document and Code Contributions.

  • code style
  • documentation style
  • quick starts
  • sphinx-copybutton for copy button in code blocks
  • add kind:minor,help wanted,good first issue to doc issue template

How was this patch tested?

  • Add some test cases that check the changes thoroughly including negative and positive cases if possible

  • Add screenshots for manual tests if appropriate

image

  • Run test locally before make a pull request

@github-actions github-actions bot added kind:documentation Documentation is a feature! kind:infra license, community building, project builds, asf infra related, etc. labels Apr 25, 2023
@yaooqinn yaooqinn self-assigned this Apr 25, 2023
@yaooqinn yaooqinn added this to the v1.8.0 milestone Apr 25, 2023
@codecov-commenter
Copy link

codecov-commenter commented Apr 25, 2023

Codecov Report

Merging #4768 (3a0bd39) into master (0f82625) will decrease coverage by 0.05%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #4768      +/-   ##
============================================
- Coverage     58.02%   57.97%   -0.05%     
  Complexity       13       13              
============================================
  Files           580      581       +1     
  Lines         32220    32437     +217     
  Branches       4302     4313      +11     
============================================
+ Hits          18696    18806     +110     
- Misses        11729    11827      +98     
- Partials       1795     1804       +9     

see 40 files with indirect coverage changes

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

~~~~~~~~~~~~~

.. code-block:: sh
:caption: Sphinx build on unix-like OS
Copy link
Member

Choose a reason for hiding this comment

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

~~~~~~~

.. code-block:: sh
:caption: Sphinx build on windows
Copy link
Member

Choose a reason for hiding this comment

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

Windows

@pan3793
Copy link
Member

pan3793 commented Apr 27, 2023

Thanks, merged to master

@pan3793 pan3793 closed this in 5032901 Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation Documentation is a feature! kind:infra license, community building, project builds, asf infra related, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants