https://github.com/microsoft/code-with-engineering-playbook

This is the playbook for "code-with" customer or partner engagements
https://github.com/microsoft/code-with-engineering-playbook

Last synced: about 1 month ago
JSON representation

This is the playbook for "code-with" customer or partner engagements

• Host: GitHub
• URL: https://github.com/microsoft/code-with-engineering-playbook
• Owner: microsoft
• License: cc-by-4.0
• Created: 2018-07-30T12:49:10.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T09:04:52.000Z (about 2 months ago)
• Last Synced: 2024-10-01T04:41:07.341Z (about 1 month ago)
• Language: Dockerfile
• Homepage: https://microsoft.github.io/code-with-engineering-playbook/
• Size: 87 MB
• Stars: 2,226
• Watchers: 2,261
• Forks: 587
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• jimsghstars - microsoft/code-with-engineering-playbook - This is the playbook for "code-with" customer or partner engagements (Dockerfile)

README

        
# ISE Engineering Fundamentals Customer/Partner Engineering Playbook

An engineer or data scientist working on an [ISE](docs/ISE.md) project...

* Has responsibilities to their team – mentor, coach, and lead.

* Knows their **playbook**. Follows their playbook. Fixes their playbook if it is broken. If they find a better playbook, they copy it. If somebody could use your playbook, give them yours.

* Leads by example. Models the behaviors we desire both interpersonally and technically.

* Strives to understand how their work fits into a broader context and ensures the outcome.

This is our playbook. All contributions welcome! Please feel free to submit a [pull request](https://github.com/microsoft/code-with-engineering-playbook/pulls) to get involved.

> **Note:** If you are reading this on GitHub - head over to [https://microsoft.github.io/code-with-engineering-playbook/](https://microsoft.github.io/code-with-engineering-playbook/) for a better reading experience

## Why Have A Playbook

* To increase overall efficiency for team members and the whole team in general.

* Reduce the number of mistakes and avoid common pitfalls.

* Strive to be a better engineer and learn from other people's shared experience.

## "The" Checklist

If you do nothing else follow the [Engineering Fundamentals Checklist](docs/engineering-fundamentals-checklist.md)! It's here to help follow the Engineering Fundamentals.

## Structure of a Sprint

A [breakdown of sections](docs/the-first-week-of-an-ise-project.md) according to the structure of an Agile sprint.

## General Guidance

* Keep the code quality bar high.

* Value quality and precision over ‘getting things done’.

* Work diligently on the one important thing.

* As a distributed team take time to share context via wiki, teams and backlog items.

* Make the simple thing work now. Build fewer features today, but ensure they work amazingly. Then add more features tomorrow.

* Avoid adding scope to a backlog item, instead add a new backlog item.

* Our goal is to ship incremental customer value.

* Keep backlog item details up to date to communicate the state of things with the rest of your team.

* Report product issues found and provide clear and repeatable engineering feedback!

* We all own our code and each one of us has an obligation to make all parts of the solution great.

## Resources

* [Engineering Fundamentals Checklist](docs/engineering-fundamentals-checklist.md)

* [The first week of an ISE project](docs/the-first-week-of-an-ise-project.md)

## Engineering Fundamentals

* [Accessibility](docs/non-functional-requirements/accessibility.md)

* [Agile Development](docs/agile-development/README.md)

* [Automated Testing](docs/automated-testing/README.md)

* [Code Reviews](docs/code-reviews/README.md)

* [Continuous Delivery (CD)](docs/CI-CD/continuous-delivery.md)

* [Continuous Integration (CI)](docs/CI-CD/continuous-integration.md)

* [Design](docs/design/readme.md)

* [Developer Experience](docs/developer-experience/README.md)

* [Documentation](docs/documentation/README.md)

* [Engineering Feedback](docs/engineering-feedback/README.md)

* [Observability](docs/observability/README.md)

* [Security](docs/security/README.md)

* [Privacy](docs/privacy/README.md)

* [Source Control](docs/source-control/README.md)

* [Reliability](docs/non-functional-requirements/reliability.md)

## Fundamentals for Specific Technology Areas

* [Machine Learning Fundamentals](docs/machine-learning/README.md)

* [User-Interface Engineering](docs/UI-UX/README.md)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.