-
Notifications
You must be signed in to change notification settings - Fork 8
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
Describe Engineering Best Practices #263
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
I think this will be worth highlighting in our blog/feattured news
- `Travis CI <https://www.travis-ci.com>`__ | ||
- `Jenkins <https://www.jenkins.io>`__ | ||
|
||
GitHub Actions, CircleCI and Travis CI are cloud services; Jenkins is a server you set up in your own infrastructure. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe throw some "generally" in here. I think there are companies that sell Jenkins as a service and GitHub Actions allows you to farm out jobs to your own infrastructure, but those are exceptions that "generally" probably covers our butt enough
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The content is good. There's some room to tighten up the phrasing, use active voice, etc. I wonder if there's a tool that analyzes a target sentence/paragraph/document and spits out a version that reads better, this seems like a task that the AI would excel at... (Edit: It flows better than the average existing doc page, no need to improve it now...)
docs/advanced-topics/best-practices/best-practices-development.rst
Outdated
Show resolved
Hide resolved
docs/advanced-topics/best-practices/best-practices-development.rst
Outdated
Show resolved
Hide resolved
Tried to address some of the passive voice stuff, but I think I use it so frequently I may not have caught it all. We have a ticket for a broader improvement/tooling, but I'd consider that beyond the scope of this release. |
Description
The issue title is "Document CI/CD best practices for workflows"; I broadened it to general software engineering practices.
It's hard to strike the right balance; I can't replace a book. I was also running a bit out of steam. Hopefully this works, although it might be a little thin.
I don't really talk about CI/CD; I feel they're technically not the same thing as automated builds, although automated builds are part of CI. But I'm open to suggestions.
Issue
dockstore/dockstore#3669
Please make sure that you've checked the following before submitting your pull request. Thanks!