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

story(evrys): define contributing guidelines #44

Open
5 tasks
Zaba505 opened this issue Nov 3, 2022 · 1 comment
Open
5 tasks

story(evrys): define contributing guidelines #44

Zaba505 opened this issue Nov 3, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation story
Milestone

Comments

@Zaba505
Copy link
Member

Zaba505 commented Nov 3, 2022

Description

As a contributor, I want to know the expectations for making a contribution, so that I can easily make a contribution.

Acceptance Criteria

  • Document code styling
  • Document agile practices
  • Define commit message standards
  • Define other expected "best practices"
  • Also define developer standards in separate file

Related Issues

No response

@Zaba505 Zaba505 added documentation Improvements or additions to documentation story labels Nov 3, 2022
@Zaba505 Zaba505 added this to the v0 milestone Nov 3, 2022
@Zaba505 Zaba505 self-assigned this Nov 3, 2022
@Zaba505 Zaba505 added this to evrys Nov 3, 2022
@Zaba505 Zaba505 moved this to Refinement in evrys Nov 3, 2022
@Zaba505
Copy link
Member Author

Zaba505 commented Nov 5, 2022

@erictg Definitely feel free to add to this list so we can track code standards for now

Define a section for development standards:

  • Never create a util, common, or other generic name package
  • Always "minimally" wrap any error before returning it
  • Don't include method/function calls in assert statements for better readability

@Zaba505 Zaba505 moved this from Refinement to Backlog in evrys Nov 5, 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 story
Projects
No open projects
Status: Backlog
Development

No branches or pull requests

1 participant