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.

Sign up for GitHub

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

Jump to bottom

Docs for the package #671

Closed
10 tasks done
jainmohit2001 opened this issue Oct 15, 2024 · 3 comments
Closed
10 tasks done

Docs for the package #671

jainmohit2001 opened this issue Oct 15, 2024 · 3 comments
Assignees
@proelke @mdwcrft
Labels
documentation good first issue Good for newcomers

Comments

@jainmohit2001
Copy link
Collaborator

jainmohit2001 commented Oct 15, 2024 •
edited
Loading

The following list of docs are necessary and good-to-have templates

  • README.md
  • CHANGELOG.md
  • Issue templates
    • Bug report template
    • Feature request template
    • Documentation request template
  • SECURITY.md
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md
  • SUPPORT.md

We welcome PRs for the above docs from the community.
@jainmohit2001
Copy link
Collaborator Author

@mdwcrft @proelke, we can use the following resources to add relevant templates to the repo. I believe only you have the permission to do this action.

Resources:

mdwcrft added a commit that referenced this issue Nov 18, 2024
@mdwcrft
Add issue templates
f5a1a97 
Adds issue templates, contributes to #671
@mdwcrft mdwcrft mentioned this issue Nov 18, 2024
Merged
@mdwcrft
Copy link
Collaborator

mdwcrft commented Nov 18, 2024

@jainmohit2001 - new issue templates proposed here: #679

jainmohit2001 added a commit that referenced this issue Nov 20, 2024
@mdwcrft @jainmohit2001
Add issue templates (#679)
5069156 
Adds issue templates, contributes to
#671

---------

Co-authored-by: Mohit Jain <[email protected]>
ajmirsky added a commit to ajmirsky/ocpp that referenced this issue Nov 22, 2024
@ajmirsky
Add code of conduct, contributing, security and support docs.
68e048b 
Also includes a pull request template.

Contributes to mobilityhouse#671
@ajmirsky ajmirsky mentioned this issue Nov 22, 2024
Merged
ajmirsky pushed a commit to ajmirsky/ocpp that referenced this issue Nov 26, 2024
@mdwcrft @jainmohit2001
Add issue templates (mobilityhouse#679)
a6699dc 
Adds issue templates, contributes to
mobilityhouse#671

---------

Co-authored-by: Mohit Jain <[email protected]>
ajmirsky added a commit to ajmirsky/ocpp that referenced this issue Nov 26, 2024
@ajmirsky
Add code of conduct, contributing, security and support docs.
202ee30 
Also includes a pull request template.

Contributes to mobilityhouse#671
@jainmohit2001 jainmohit2001 mentioned this issue Dec 7, 2024
Open
jainmohit2001 pushed a commit to ajmirsky/ocpp that referenced this issue Dec 9, 2024
@ajmirsky @jainmohit2001
Add code of conduct, contributing, security and support docs.
56220a0 
Also includes a pull request template.

Contributes to mobilityhouse#671
jainmohit2001 pushed a commit to ajmirsky/ocpp that referenced this issue Dec 9, 2024
@ajmirsky @jainmohit2001
Add code of conduct, contributing, security and support docs.
a32dec2 
Also includes a pull request template.

Contributes to mobilityhouse#671
jainmohit2001 pushed a commit to ajmirsky/ocpp that referenced this issue Dec 9, 2024
@ajmirsky @jainmohit2001
Add code of conduct, contributing, security and support docs.
c3a9638 
Also includes a pull request template.

Contributes to mobilityhouse#671
jainmohit2001 added a commit that referenced this issue Dec 9, 2024
@ajmirsky @jainmohit2001 @mdwcrft
chore: Add code of conduct, contributing, security and support docs. (#…
cf21e48 
…681)

Based on examples from other open-source repos in github:

- code of conduct for those participating in the project
- instructions for contributing to the project (including a pull request
template to help facilitate)
- how to report a security vulnerability
- expectations of getting help with the project

Contributes to #671

---------

Co-authored-by: Mohit Jain <[email protected]>
Co-authored-by: Chad <[email protected]>
@jainmohit2001
Copy link
Collaborator Author

Closing as completed in #681.

Thanks @ajmirsky for the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@proelke proelke

@mdwcrft mdwcrft

Labels
documentation good first issue Good for newcomers
Milestone
No milestone
Development

No branches or pull requests
3 participants
@proelke @mdwcrft @jainmohit2001