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

Add Documentation for Development Practices and Improve Contributing Docs #97

Open
engineerjoe440 opened this issue Jul 5, 2022 · 0 comments
Open

Add Documentation for Development Practices and Improve Contributing Docs #97

engineerjoe440 opened this issue Jul 5, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Next Version 0.4.0

Comments

@engineerjoe440
Copy link
Owner

There's a real lack of documentation regarding contribution best practices and suggestions for this project. We should document some of the following:

  • how Pull Requests (PRs) should be managed
  • what documentation styles are in place (NumPyDoc)
  • contributions getting started
  • what determinations should be used to decide where new functions should be added
@engineerjoe440 engineerjoe440 added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 5, 2022
@engineerjoe440 engineerjoe440 self-assigned this Jul 5, 2022
@engineerjoe440 engineerjoe440 removed their assignment Aug 22, 2022
@engineerjoe440 engineerjoe440 added this to the Next Version 0.3.1 milestone May 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
Next Version 0.4.0
Development

No branches or pull requests
1 participant
@engineerjoe440