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

Make more welcoming to contributions #14

Open
Cali0707 opened this issue Jul 14, 2023 · 3 comments
Open

Make more welcoming to contributions #14

Cali0707 opened this issue Jul 14, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@Cali0707
Copy link
Owner

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
Copy link
Owner Author

@Leo6Leo what are your thoughts on this?

@Cali0707 Cali0707 added documentation Improvements or additions to documentation question Further information is requested labels Jul 14, 2023
@Cali0707
Copy link
Owner Author

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

@Leo6Leo
Copy link
Collaborator

Leo6Leo commented Jul 31, 2023

@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

@Leo6Leo Leo6Leo assigned Cali0707 and unassigned Leo6Leo Jul 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants