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

Write contribution and project guidelines #248

Closed
jardinetsouffleton opened this issue Sep 28, 2022 · 0 comments
Closed

Write contribution and project guidelines #248

jardinetsouffleton opened this issue Sep 28, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jardinetsouffleton
Copy link
Member

The goal of this issue is to come up with contribution and project guidelines, including, but not limited to:

  • Design philosophy: what is this project for. This will give contributors more context to come up with solutions in line with the project's goal and will increase their autonomy
  • Coding style guide and code formatter: This will guarantee a uniformity in the look of the code. This will make reading and understanding the package easier
  • Branch/release strategy: This will clarify how branches are organized and how releases are done
  • Links to tutorials, examples and blog posts: This will make onboarding easier, faster and more fun for new contributors
@jardinetsouffleton jardinetsouffleton added this to the Documentation v1 milestone Sep 28, 2022
@jardinetsouffleton jardinetsouffleton added the documentation Improvements or additions to documentation label Sep 28, 2022
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