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

Provide essential developer/contributing documentation #115

Open
sadielbartholomew opened this issue Oct 1, 2024 · 0 comments
Open

Provide essential developer/contributing documentation #115

sadielbartholomew opened this issue Oct 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sadielbartholomew
Copy link
Member

We should flesh out at least the basics of contributing and developer guidelines, since at present we only have an essential 'contributions welcome' placeholder page. At the least I would like information on the following:

  • how to run the test suite (python -m pytest in the tests directory is what I've been going with, but there is no guidance at al in this respect and it would be best to be explicit about the command intended to be used);
  • code and docsting formatting requirements;
  • how the docs are built.
@sadielbartholomew sadielbartholomew added the documentation Improvements or additions to documentation label Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant