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

chore: link to contributing guidelines from README.md #1561

Merged
merged 2 commits into from
Sep 21, 2023

Conversation

tcrasset
Copy link
Contributor

I feel it's helpful to show a newcomer how to start contributing, so I added the most basic steps. I'm leaving this intentionally very sparse so that you can add whatever you want @koxudaxi

@koxudaxi
Copy link
Owner

@tcrasset
Thank you for creating the PR.
We have the page for the contributing guide.
https://github.com/koxudaxi/datamodel-code-generator/blob/master/docs/development-contributing.md

https://koxudaxi.github.io/datamodel-code-generator/development-contributing/

But, the page is not linked from README.md.
This may be not very clear.
What do you think?

@tcrasset
Copy link
Contributor Author

Ah, indeed I missed this one, probably due to the reasons you mention. It rather common to have a CONTRIBUTING.md in open-source projects, but I agree that we do not want to duplicate the information that is already in docs/.

Adding it to README.md seems like a fair compromise.

@tcrasset tcrasset changed the title chore: add CONTRIBUTING.md chore: link to contributing guidelines from README.md Sep 21, 2023
@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (e9b6edf) 100.00% compared to head (036d88d) 100.00%.
Report is 718 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##            master     #1561     +/-   ##
===========================================
  Coverage   100.00%   100.00%             
===========================================
  Files           11        33     +22     
  Lines         1020      3621   +2601     
  Branches       201       841    +640     
===========================================
+ Hits          1020      3621   +2601     
Flag Coverage Δ
unittests 99.64% <99.59%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
datamodel_code_generator/__init__.py 100.00% <100.00%> (ø)
datamodel_code_generator/__main__.py 100.00% <100.00%> (ø)
datamodel_code_generator/arguments.py 100.00% <100.00%> (ø)
datamodel_code_generator/format.py 100.00% <100.00%> (ø)
datamodel_code_generator/http.py 100.00% <100.00%> (ø)
datamodel_code_generator/imports.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/__init__.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/base.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/dataclass.py 100.00% <100.00%> (ø)
datamodel_code_generator/model/enum.py 100.00% <100.00%> (ø)
... and 23 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -18,7 +19,7 @@ $ git clone git@github.com:<your username>/datamodel-code-generator.git
$ cd datamodel-code-generator

## 2. Install [poetry](https://github.com/python-poetry/poetry)
$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
$ curl -sSL https://install.python-poetry.org | python3 -
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The old installer is deprecated

@koxudaxi koxudaxi merged commit da4cbf5 into koxudaxi:master Sep 21, 2023
73 checks passed
@tcrasset tcrasset deleted the tc/add-contributing.md branch September 22, 2023 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants