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

Create a CONTRIBUTING.md definition #81

Open
Mandera opened this issue Apr 16, 2023 · 2 comments
Open

Create a CONTRIBUTING.md definition #81

Mandera opened this issue Apr 16, 2023 · 2 comments
Milestone
Contributing

Comments

@Mandera
Copy link
Collaborator

Mandera commented Apr 16, 2023 •
edited
Loading

  • Welcome users
  • Tell them how to setup the environment
    • Either clone a specific repo and then run generate.py
    • Or pip install generalpackager then run Packager().create_blank_locally() or something
  • Mention the Apache 2 license
  • Small PR guide
  • Code style
  • Unittests
  • Principles such as DRY

Probably missed something
@Mandera Mandera changed the title Create a CONTRIBUTING.md Create a CONTRIBUTING.md definition Apr 16, 2023
This was referenced Apr 16, 2023
Closed
Merged
@ZanSara
Copy link

ZanSara commented Apr 17, 2023

For what is worth, I could get going by just cloning the repo and running pip install -e ., which is great 🙂

Out of curiosity, what would generate.py do?

@Mandera
Copy link
Collaborator Author

Mandera commented Apr 18, 2023

Nice, that's good to know, and definitely something that'd be nice to continue supporting! I mainly had

in mind. generate.py would replace pre-commit install and possibly do more, but writing this made me think

@Mandera Mandera added this to the Contributing milestone May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
All Issues
Status: No status
Milestone
Contributing
Development

No branches or pull requests
2 participants
@Mandera @ZanSara