Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Contributing Guidelines and Development Workflow #2

Open
7 tasks
seansica opened this issue Jun 16, 2022 · 0 comments
Open
7 tasks

Add Contributing Guidelines and Development Workflow #2

seansica opened this issue Jun 16, 2022 · 0 comments
Assignees

Comments

@seansica
Copy link
Contributor

seansica commented Jun 16, 2022

Description

We should establish formal contributing guidelines and development workflow documentation for the attack-workbench-taxii-server repository, matching the standards set in our attack-data-model repo.

This will include:

  1. Basic contribution guidelines (issue templates, PR process)
  2. Development workflow setup with:
    • ESLint + Prettier for code quality and formatting
    • Husky for Git hooks:
      • Pre-commit: Run formatting
      • Pre-push: Run tests
      • Commit-msg: Enforce conventional commits
  3. Semantic-release configuration:
    • Standard plugins and channels
    • Version management approach
    • Release workflow documentation

Implementation Tasks

  • Copy and adapt CONTRIBUTING.md from attack-data-model
  • Set up ESLint + Prettier with same config
  • Configure Husky with identical Git hooks
  • Install and configure semantic-release
  • Add issue templates for bugs and feature requests
  • Update package.json with required dependencies and scripts
  • Update README.md to reference new contributing guidelines

Additional Notes

Reference repo: https://github.com/mitre-attack/attack-data-model

The goal is to maintain consistency across our repos while making it easier for contributors to participate in development.

@seansica seansica self-assigned this Jun 16, 2022
@seansica seansica changed the title Implement ES-Lint Add Contributing Guidelines and Development Workflow Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant