Skip to content

Commit

Permalink
chore: update CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
Maximus7474 committed Aug 16, 2024
1 parent ce31c90 commit e7feaeb
Showing 1 changed file with 75 additions and 3 deletions.
78 changes: 75 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,90 @@ Welcome to the Squad 44 Community Bot repository! We appreciate your interest in
git push origin feature/your-feature-name
```

## Updating `vehicleInfo.json`
When updating the `vehicleInfo.json` file, please follow the established template structure for different categories of vehicles: **Tanks**, **Vehicles**, and **Canons**.

### Tanks Template
Each tank entry should be structured as follows:

```json
"Tank Name": {
"team": "Axis" or "Allies",
"type": "Light/Recon/Medium/Heavy Tank",
"factions": ["1st Airborne", "Polish Brigade", "Wehrmacht", "9.SS Panzer", "etc..."],
"chapters": ["I", "II", "III", "IV", "Mercury"],
"image": "url to an image", // or null
"details": {
"crew": [
"Driver", "Gunner", "Hull-Gunner", "Commander"
],
"passengers": 7, // optional
"caliber": "50mm",
"shells": {
"APC-HE-T": "X",
"APCR-T": "X"
}
}
}
```

### Vehicles Template
Each vehicle entry should be structured as follows:

```js
"Name": {
"team": "Allies" || "Axis",
"class": "Specialized" || "Mechanized",
"type": "Specialized Vehicle" || null, // Optional value
"factions": ["1st Airborne", "Polish Brigade", "Wehrmacht", "9.SS Panzer", "etc..."],
"chapters": ["I", "II", "III", "IV", "Mercury"],
"seats": 5, // Required value
"weaponry": {
"Vickers MG": 1
} // or set the value to null if no weapons or it's not applicable
}
```

### Canons Template
Each canon entry should be structured as follows:

```json
"QF. 6 Pounder": {
"team": "Allies" || "Axis",
"type": "Anti-Tank Canon", // or "Anti-Infantry Gun", "etc..."
"factions": ["1st Airborne", "Polish Brigade", "Wehrmacht", "9.SS Panzer", "etc..."],
"chapters": ["I", "II", "III", "IV", "Mercury"],
"weaponry": {
"Canon Calibre": 1 // any value, not used for the moment
}
}
```

Ensure that all fields are accurately filled out according to the vehicle's characteristics. If a field is optional and not applicable, you may omit it or set it to `null` as indicated.

## Submitting Your Changes

1. **Create a Pull Request**: Navigate to the [Pull Requests](https://github.com/Maximus7474/Squad44Bot/pulls) tab in the main repository and click on "New Pull Request." Select your branch and submit the pull request with a descriptive title and comments.
2. **Review and Feedback**: Your pull request will be reviewed by the project maintainers. Be prepared to make adjustments based on feedback.

<!-- ## Style Guide
## Style Guide
- **Code Formatting**: Ensure your code is consistently formatted, adhere to the project's existing style.
- **Comments**: Comment your code where necessary, especially complex logic.
- **Naming Conventions**: Use clear and descriptive names for variables, functions, and classes.

## Testing
Before submitting your pull request, ensure that your code passes all existing tests. If you've added new functionality, please write corresponding tests.



To maintain consistency, follow our [Coding Style Guide](./STYLE_GUIDE.md). This includes guidelines for code formatting, naming conventions, and more. -->
## Pull Requests
When submitting a pull request, please ensure the following:
- All tests pass successfully.
- Your pull request includes relevant documentation updates.

## Additional Resources

<!-- - **Documentation**: Refer to the [Documentation](./docs/) for detailed information about the project. -->
- **Community**: Join our [Discussion Forum](https://github.com/Maximus7474/Squad44Bot/discussions) for community support and conversations.
- **Community**: Join our [Discussion Forum](https://github.com/Maximus7474/Squad44Bot/discussions) or our [Discord Server](https://discord.gg/6mgjuBnmHC) for community support and conversations.

Thank you for contributing to Squad 44 Community Bot! We look forward to your contributions.

0 comments on commit e7feaeb

Please sign in to comment.