Skip to content
This repository has been archived by the owner on Feb 19, 2022. It is now read-only.

Latest commit

 

History

History
139 lines (106 loc) · 5.1 KB

CONTRIBUTING.md

File metadata and controls

139 lines (106 loc) · 5.1 KB
Raw

Contributing

Thanks for helping out!

Dependencies

We have a three-way dependency scheme:

  • package.json:dependencies: Production dependencies for the archetype installed in a project.
  • package.json:devDependencies: The development dependencies used internally for the this archetype during development (self tests, checks, etc.) that are not part of the overall archeype outside workflow.
  • ../builder-victory-component-dev/package.json:dependencies: Development dependencies for the archetype installed in a project.

Checks, Tests

Run npm run builder:check

Documentation

To generate the usage snippet in the README.md, first go to a project that uses the archetype and then run:

$ builder help builder-victory-component

Then paste in the output. Auto-generating the usage snippet is coming! See FormidableLabs/builder#12.

Release

For tagged official releases only, make sure to:

  1. Update appropriate HISTORY.md notes
  2. Bump package.json version
  3. Generate a new ARCHETYPE-dev package.json. Make sure that you have https://github.com/FormidableLabs/builder-victory-component-dev checked out at a parallel location to this project and in a state ready to receive code / git changes for publishing.
  4. Add to git, tag, and publish
# Publish main archetype
$ vim HISTORY.md              # Version notes
$ vim package.json            # Bump version
$ builder-support gen-dev     # Create `../builder-victory-component-dev/` files
$ npm run builder:check       # Last check!
$ git add package.json HISTORY.md
$ git commit -m "Version NUMBER"
$ git tag -a "vNUMBER" -m "Version NUMBER"
$ git push && git push --tags
$ npm publish

# Publish dev archetype in sister directory
$ cd ../builder-victory-component-dev
$ git add .
$ git commit -m "Version NUMBER"
$ git tag -a "vNUMBER" -m "Version NUMBER"
$ git push && git push --tags
$ npm publish

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

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, insulting/derogatory comments, and 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, 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 the project team at lauren.eastridge@formidable.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is 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, available at http://contributor-covenant.org/version/1/4