|
| 1 | +# Contributing to MITRE ATT&CK® Data Model |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the MITRE ATT&CK® Data Model! We welcome contributions from the community to help improve and expand this TypeScript library. |
| 4 | + |
| 5 | +## How to Contribute |
| 6 | + |
| 7 | +We don't have a formal process or Standard Operating Procedure (SOP) for accepting changes. However, there are several ways you can contribute: |
| 8 | + |
| 9 | +1. **Open Issues**: If you encounter bugs or have feature requests, please open an issue using the templates provided below. |
| 10 | +2. **Submit Pull Requests**: Feel free to fork the repository, make changes, and submit a pull request. We will review your changes as necessary. |
| 11 | + |
| 12 | +## Issue Templates |
| 13 | + |
| 14 | +### Bug Report |
| 15 | + |
| 16 | +When reporting a bug, please use the following template: |
| 17 | + |
| 18 | +``` |
| 19 | +## Expected Behavior |
| 20 | +
|
| 21 | +
|
| 22 | +## Actual Behavior |
| 23 | +
|
| 24 | +
|
| 25 | +## Steps to Reproduce the Problem |
| 26 | +
|
| 27 | + 1. |
| 28 | + 2. |
| 29 | + 3. |
| 30 | +
|
| 31 | +## Possible Solution |
| 32 | +
|
| 33 | +``` |
| 34 | + |
| 35 | +### Feature Request |
| 36 | + |
| 37 | +For feature requests, please use this template: |
| 38 | + |
| 39 | +``` |
| 40 | +### Is your feature request related to a problem? |
| 41 | +Please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] |
| 42 | +
|
| 43 | +### Describe the solution you'd like |
| 44 | +A clear and concise description of what you want to happen. |
| 45 | +
|
| 46 | +### Describe alternatives you've considered |
| 47 | +A clear and concise description of any alternative solutions or features you've considered. |
| 48 | +
|
| 49 | +### Additional context |
| 50 | +Add any other context or screenshots about the feature request here. |
| 51 | +``` |
| 52 | + |
| 53 | +## Pull Request Guidelines |
| 54 | + |
| 55 | +When submitting a pull request: |
| 56 | + |
| 57 | +1. Fork the repository and create your branch from `develop`. |
| 58 | +2. Ensure your code adheres to the existing style of the project to maintain consistency. |
| 59 | +3. Include comments in your code where necessary. |
| 60 | +4. Update the `README.md` with details of changes to the interface, if applicable. |
| 61 | +5. Increase the version numbers in any examples files and the `README.md` to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). |
| 62 | +6. Include a description of your changes and why they're necessary. |
| 63 | + |
| 64 | +## Questions? |
| 65 | + |
| 66 | +If you have any questions about contributing, please open an issue and we'll be happy to help! |
| 67 | + |
| 68 | +Thank you for your contributions to make the MITRE ATT&CK® Data Model better for everyone! |
0 commit comments