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

Update contributing guide so new contributors can successfully install dependencies #4161

Merged
merged 5 commits into from
Oct 10, 2019

Conversation

icmpecho
Copy link
Contributor

@icmpecho icmpecho commented Oct 9, 2019

What do these changes do?

Update contributing guide so new contributors can successfully install dependencies

Are there changes in behavior for the user?

no

Related issue number

Fixes #4160

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 9, 2019
@codecov-io
Copy link

codecov-io commented Oct 9, 2019

Codecov Report

Merging #4161 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4161   +/-   ##
=======================================
  Coverage   97.63%   97.63%           
=======================================
  Files          43       43           
  Lines        8825     8825           
  Branches     1381     1381           
=======================================
  Hits         8616     8616           
  Misses         88       88           
  Partials      121      121

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0a9c4ba...2b06a83. Read the comment docs.

@asvetlov asvetlov changed the title Update contributing guide so new contributors can successfully instal… Update contributing guide so new contributors can successfully install dependencies Oct 9, 2019
Copy link
Member

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

This can work but I prefer a couple commands here:

make cythonize
pip install -r requirements/dev.txt

@asvetlov
Copy link
Member

Another option can be adding make develop command and documenting it.
It can be an alias for .develop but without a confusing dot at the front.

@icmpecho
Copy link
Contributor Author

@asvetlov ok I'll fix that. how about something like make install-dev

@asvetlov
Copy link
Member

how about something like make install-dev

Sounds good

@asvetlov asvetlov merged commit f1d7a63 into aio-libs:master Oct 10, 2019
@asvetlov
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error while installing dependency using the contributing guide
3 participants