Skip to content

Add CONTRIBUTING.md #387

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

Closed
junkmd opened this issue Nov 28, 2022 · 2 comments · Fixed by #396
Closed

Add CONTRIBUTING.md #387

junkmd opened this issue Nov 28, 2022 · 2 comments · Fixed by #396
Labels
shared_info use cases, tips and troubleshoots

Comments

@junkmd
Copy link
Collaborator

junkmd commented Nov 28, 2022

Let's create documentation with guidelines for new contributors!

Any opinions would be appreciated.

@junkmd junkmd added the shared_info use cases, tips and troubleshoots label Nov 28, 2022
@junkmd
Copy link
Collaborator Author

junkmd commented Nov 29, 2022

python/typeshed and pola-rs/polars are repositories that could be used as references.

For those contributors who would like to know about the appropriate amount of changes to submit in one PR, we should suggest google's Small CLs.

@junkmd
Copy link
Collaborator Author

junkmd commented Dec 3, 2022

I am doing "issue inventory" during my free time.
I thought there were cases where anyone could not react due to lack of written information about the environment or code snippets when an error occurred.

I found the microsoft/pylance-release issue format to be useful in getting information from the reporter.

I wrote the format based on that.

## Environment data

<!--
your `OS`, `Python` and `comtypes` version, what type libraries you want to use.
-->

## Code Snippet

<!--
Please provide a minimal, self-contained code snippet that reproduces the issue. GitHub permalink is very useful.
-->

# ```py
# XXX
# ```

## Situation reproducing Steps

<!--
Delete this section if not needed.
-->

1. XXX
2. XXX

## Expected behavior

XXX

## Actual behavior

XXX

Any opinions would be appreciated.

@junkmd junkmd linked a pull request Dec 10, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
shared_info use cases, tips and troubleshoots
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant