mrm-preset-osuresearch

🧰 OSU Research Mrm Preset

The OSU Research preset for Mrm adds a suite of tasks to keep project configuration files in-sync and policies compliant across university projects.

Getting Started

All tasks are available under the osuresearch preset.

For full project scaffolding, we have a few aliased variations available that will walk you through the setup process.

Create a React Components Package

npx mrm react-package --preset osuresearch

Batteries included:

• React 18 with TypeScript
• Jest with a jsdom environment
• ESLint and Prettier for code linting
• Bundling for esm, cjs + umd
• Conventional commits for Semantic Release GitHub Action
• Standard GitHub issue workflows and contribution guidelines

Once configured, you can boot up Storybook and start developing components

npm run storybook

🤔 TODO: More!

Tasks

Each task is isolated into its own directory with a README.md to describe what codemods the task performs.

Some tasks may support additional configurations.

For example, if you want to replace the contribution contacts, you can pass those into the preset task:

npx mrm contributing
  --preset osuresearch
  --config:securityContact "[e-mail]"
  --config:conductContact "[e-mail]"

Policies and Procedures

For folks who like to focus on policy review, the generated policies are:

• Submitting Feature Requests
• Submitting Bug Reports
• Submitting Other Issues
• Contributor Code of Conduct
• Code Contribution Guidelines
• Commit Conventions
• MIT License

For further questions regarding policies and procedures, contact Chase [e-mail].