issue_comments: 1492349784

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-1492349784 https://api.github.com/repos/pydata/xarray/issues/4361 1492349784 IC_kwDOAMm_X85Y83NY 51911758 2023-03-31T17:39:00Z 2023-03-31T17:39:00Z CONTRIBUTOR

An overview would make it easier to find sections for sure. Including what you've mentioned, here's what I have for the overview:

Overview

Project Structure

Prerequisites * Set up your development environment * Linux * Windows * Git workflow (Will link to an external resource)

Code * Suggest a feature * Report a bug * Find an issue to work on * Set up the environment * Making changes * Create branch * Edit files * Documenting your changes * Testing * Writing tests * Running tests (for both the code and the docstrings where necessary ) * Commit your changes Links to the section that mentions pre-commit (and the pre-commit-ci bot) and commit message tags for controlling CI * Push to fork * Create a pull request * Automated tests * Backward Compatibility * Code standards and conventions

Documentation * Suggest doc improvements * Find something to work on * Making small changes (e.g typo fixes) * Check existing GitHub issues * Propose a change * Set up the documentation environment * Ways to contribute to the documentation * User guide * Make changes * Build docs * Docstrings * Make changes * Docstrings format * How to write numpy style docstrings * Examples * Run doctests

  • Create a pull request

PR best practices (Will link to short section on what to put into the PR description / title)

I have tried to make the contribution workflow for the docs and code as separate as possible which I think makes it easier to follow.

 
{
    "total_count": 0,
    "+1": 0,
    "-1": 0,
    "laugh": 0,
    "hooray": 0,
    "confused": 0,
    "heart": 0,
    "rocket": 0,
    "eyes": 0
}
   683142059