Design Pattern Template

21 March 2022 by Phillip Johnston • Last updated 24 March 2022Here is the Markdown template we use for documenting design patterns used in our repositories and on our website. Put a 1-2 line summary description up top. Include a brief classification of this pattern (Structural, Decoupling, etc.) if relevant for your purposes. ## Aliases – List any known aliases for this pattern ## Context It can be helpful to give readers brief context and description of the pattern prior to reading the rest of the pattern document. You can also use this as an “Intent” section. – How does …

Embedded Artistry’s Development Build Inventory Templates for SMA and FATP

If you are building an embedded hardware product, it is important that you keep careful track of parts and materials needed for your engineering development builds. This is essential even if you are already using a well-managed BOM. Development builds should be scheduled such that all materials are ready and QA’d to allow for the shortest, …

Embedded Artistry Code of Conduct

This code of conduct governs all Embedded Artistry open-source project contributors and members of our community.

You can find a Markdown version of this Code of Conduct in the embeddedartistry/templates GitHub repository. Feel free to use this Code of Conduct as a starting point for your own projects.

Table of Contents:

Version: 1.0.2

Summary

As contributors and maintainers of Embedded Artistry projects, we will respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.

Communication regarding Embedded Artistry projects through any channel must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. Courtesy and respect shall be extended to everyone involved in this project. Our experiences as individuals differs widely, and as such contributors are expected to be respectful of differing viewpoints and ideas.

We expect all contributors to uphold our standards of conduct. If any member of the community violates this code of conduct, the Embedded Artistry team and project maintainers will take action. We reserve the right to remove issues, comments, and PRs that do not comply with our conduct standards. Repeated or significant offenses will result in blocked accounts and disassociation with our projects and the Embedded Artistry community.

If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at contact@embeddedartistry.com.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling
  • Insults or other derogatory comments
  • Personal or political attacks
  • Public or private harassment
  • Publishing others’ private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, discussions in the Embedded Artistry forum, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting Embedded Artistry at contact@embeddedartistry.com.

All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. We are obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4

Need a consulting agreement template? Check out these two from the IEEE

When I started consulting, getting contracts in place was one of the most intimidating activities. The contract situation changes from client to client: some expect me to provide the consulting agreement, others expect to use their own 8-page agreement prepared by their lawyers, and the rare prospect expected me to start working just because we …