issue_comments: 1477031884

This data as json

html_url issue_url id node_id user created_at updated_at author_association body reactions performed_via_github_app issue
https://github.com/pydata/xarray/issues/4361#issuecomment-1477031884 https://api.github.com/repos/pydata/xarray/issues/4361 1477031884 IC_kwDOAMm_X85YCbfM 51911758 2023-03-20T22:33:27Z 2023-03-20T22:33:27Z CONTRIBUTOR

@keewis What do you think of this structure?

Structure for the Contribution Guide

Overview

  • A brief introduction to the community.
  • Communication channels
  • Where to look for your first issue i.e tags to look out for. For both the code and docs.

Ways to Contribute

  • Report a bug
  • Request an enhancement
  • Contribute to the codebase
  • Contribute to the documentation

How to Report a Bug

How to Request an Enhancement

Setting Up the Development Environment

Before contributing to either the docs or the codebase, set up the dev environment. * Install Anaconda or miniconda * Fork the repository * Clone the repository

Contribute to the Codebase

Code standards

  • Code formatting
  • Backward compatibility

How to contribute to the codebase

  • Set up the development environment
  • On Linux
  • On Windows
  • Set up the test environment
  • Build and install xarray
  • Create a feature branch
  • Make changes
  • Testing
    • Testing with CI
    • Writing tests
    • Using pytest
    • Running the performance test suite
  • Documenting your code
  • Review your code
  • Commit your code
  • Submit the pull request
    • PR checklist
  • Delete the merged branch

Contribute to the documentation

Documentation comprises of: * Docstrings - Add a numpy docstring guide * Docs in the xarray/doc folder - Uses rst

How to contribute to the documentation

  • Set up the docs environment
    • On Linux
    • On Windows
  • Build the documentation
  • Make changes
  • Review your changes
  • Submit a pull request
 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   683142059