secure-systems-lab / lab-guidelines

How-to guides for Secure Systems Lab (SSL) projects and documents
https://ssl.engineering.nyu.edu/
MIT License
11 stars 8 forks source link

Moves and updates basic development workflow #4

Closed lukpueh closed 6 years ago

lukpueh commented 7 years ago

@awwad has created a nice document about our lab development workflow in https://github.com/secure-systems-lab/code-style-guidelines/pull/8. I think this repo is better fit for such instructions. So after plenty of rebasing and cherry picking I moved his document over here.

While doing that I updated the basic workflow and stripped out some WIP further reading sections and added them to a new document available in the dev-workflow-misc branch, which still needs some work.

I think for now, we should be fine with this basic description. But, please feel free to review, comment and/or change, ...

awwad commented 7 years ago

I hijacked this a bunch, as discussed. 🙊

What do you think of the direction taken, @lukpueh ?

lukpueh commented 6 years ago

I would say the overall workflow in dev-workflow.md and the commit section in commits.md are pretty solid. Let's merge and create a separate PR for an update of the "Pull Request guidelines" which I have labeled (WIP) for now. What does everyone think?

vladimir-v-diaz commented 6 years ago

I think it's fine to merge.

Is there a reason why this pull request must be merged now?

lukpueh commented 6 years ago

The reason why I'd like to merge now is that I've repeatedly pointed students and co-workers to this PR (because IMHO it already gives an excellent overview of our typical workflow). So I thought merging would acknowledge that these guidelines are already valid. And it would also give us a base for all sorts of enhancements, e.g. more details on PRs, linking to GitHub templates, including git and GitHub tutorials, ...

lukpueh commented 6 years ago

I'd say we have something we can use. Let's merge and fix/add contents as we move forward.

vladimir-v-diaz commented 6 years ago

I don't think the README links to the dev workflow.

lukpueh commented 6 years ago

I think it does.