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

Add contributing file #254

Open
laysauchoa opened this issue Jan 12, 2022 · 5 comments
Open

Add contributing file #254

laysauchoa opened this issue Jan 12, 2022 · 5 comments

Comments

@laysauchoa
Copy link
Contributor

laysauchoa commented Jan 12, 2022

What can we help you with?

Hey πŸ™‹πŸ»β€β™€οΈ, do you think is a good idea to add a contributing file with the steps in how to get started contributing to this repository?
I think it makes sense to have some quick HowTo:

  • run the tests
  • debugging steps
  • how to run
  • about commit messages
  • issues
  • others

Where would you expect to find this information?

It should have it's own file and be linked to the readme of the repository

@rominf
Copy link
Contributor

rominf commented Jan 18, 2022

@laysauchoa
Copy link
Contributor Author

ah, not really! do you think it make sense to link to the readme?

@rominf
Copy link
Contributor

rominf commented Jan 18, 2022

Yes, I do.

@rominf
Copy link
Contributor

rominf commented Jan 18, 2022

Partial implementation: #261.

@TibsAtWork
Copy link
Contributor

TibsAtWork commented May 30, 2022

I think there is still a need to expand the CONTRIBUTING file to explain how to setup the development environment in order to allow running the tests.

This needs (at least):

  • pip install -r requirements.dev.txt
  • pip install requests

(so maybe requests should be added to the requirements.dev.txt file).

Also, the suggested pipenv install --three -e command complains about the -e switch, and I'm assuming we no longer support Python 2? So it might be simpler just to recommend using python -m venv venv to create a virtualenv, and then activate that.

Also explain the expected use of make lint and make reformat (or make validate-style), and the use of make pytest and when new unit tests are expected for a PR.

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

No branches or pull requests

3 participants