search

Cali0707 / git-utils

A collection of useful git tools
Apache License 2.0
4 stars 3 forks source link

Make more welcoming to contributions #14

Open Cali0707 opened 1 year ago

Cali0707 commented 1 year ago

I think there are three kinds of contributions we definitely want to be encouraging:

  1. Recommendations for new git workflows to make commands for
  2. Bug reports
  3. PRs

We should update our README to reflect this, and maybe consider adding a CONTRIBUTING.md and direct people there. Another idea is to add issue templates for bugreports/feature requests

Cali0707 commented 1 year ago

@Leo6Leo what are your thoughts on this?

Cali0707 commented 1 year ago

@Leo6Leo can you assign this back to me once you have added thoughts here?

Leo6Leo commented 1 year ago

@Cali0707 Maybe adding these, here are some of my thoughts on other form of contributions:

Code Reviews

Encourage experienced contributors to participate in code reviews. But right now I think we can take the responsibility of reviewing the code.

Documentation

Invite contributions to improve and expand documentation.

Test Cases and reproduce the issues

ask our contributors to reproduce the issue or bugs other people brought up

Tutorials

Encouraging the creation of practical examples and tutorials can aid understanding and usage of the project