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

Create coding practices SOP #9

Open
2 tasks
dfsnow opened this issue Jul 10, 2023 · 7 comments
Open
2 tasks

Create coding practices SOP #9

dfsnow opened this issue Jul 10, 2023 · 7 comments
Labels
sop Standard Operating Procedures

Comments

@dfsnow
Copy link
Member

dfsnow commented Jul 10, 2023

Now that the Data Department is growing, we should create a short document outlining coding best practices in the office. This should include things like:

  • Styling and tinting practices for different languages
  • Pre-commit standards and practices
  • Code review / PR practices
  • Standards for setting user permissions

Steps:

  • Move coding standards from handbook into separate SOP
  • Update the onboarding issue template in ccao-data/people to include link to this standard
@dfsnow dfsnow added the new label Jul 10, 2023
@dfsnow dfsnow added sop Standard Operating Procedures and removed new labels Jul 20, 2023
@dfsnow
Copy link
Member Author

dfsnow commented Jul 28, 2023

Per @jeancochrane, we should move to using Conventional Comments.

@dfsnow
Copy link
Member Author

dfsnow commented Jul 28, 2023

And we should stick to GH's branch naming convention: https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue#creating-a-branch-for-an-issue

@dfsnow
Copy link
Member Author

dfsnow commented Aug 1, 2023

Easy place to start: https://github.com/dsi-clinic/coding-standards

@dfsnow
Copy link
Member Author

dfsnow commented Aug 7, 2023

@dfsnow
Copy link
Member Author

dfsnow commented Sep 14, 2023

One more resource, per Jean: https://thoughtbot.com/playbook/developing/code-reviews

@dfsnow
Copy link
Member Author

dfsnow commented Oct 6, 2023

@dfsnow
Copy link
Member Author

dfsnow commented Oct 13, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sop Standard Operating Procedures
Projects
None yet
Development

No branches or pull requests

2 participants