docs: first draft of issue and PR template

This commit is contained in:
Fazri Gading
2026-01-23 06:00:36 +08:00
parent bb474fe233
commit da843257c1
15 changed files with 683 additions and 0 deletions

70
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,70 @@
# Contributing to Hytale F2P
Thank you for your interest in contributing to Hytale F2P! We welcome contributions from everyone. By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
## How to Contribute
### Reporting Bugs
- Use the [Bug Report](.github/ISSUE_TEMPLATE/bug_report.yml) template
- Include as much detail as possible
- Include screenshots if applicable
- Check if the issue has already been reported
### Suggesting Features
- Use the [Feature Request](.github/ISSUE_TEMPLATE/feature_request.yml) template
- Clearly describe the feature and its benefits
- Consider if the feature aligns with the project's goals
### Contributing Code
1. Fork the repository
2. Create a feature branch: `git checkout -b feature/your-feature-name`
3. Make your changes
4. Write tests if applicable
5. Ensure all tests pass
6. Update documentation if needed
7. Commit your changes: `git commit -m 'Add some feature'`
8. Push to the branch: `git push origin feature/your-feature-name`
9. Submit a pull request
### Pull Request Process
- Use the appropriate [Pull Request template](.github/PULL_REQUEST_TEMPLATE/)
- Ensure your PR description clearly describes the changes
- Link to any related issues
- Wait for review and address any feedback
## Development Setup
1. Clone the repository: `git clone https://github.com/your-username/hytale-f2p.git`
2. Install dependencies: `npm install` (or appropriate command)
3. Set up your development environment
4. Run tests: `npm test`
5. Start development server: `npm run dev`
## Code Style
- Follow the existing code style in the project
- Use meaningful variable and function names
- Write clear, concise comments
- Keep functions small and focused
## Testing
- Write unit tests for new features
- Ensure all existing tests pass
- Test on multiple platforms/browsers if applicable
## Documentation
- Update README.md if needed
- Document new features or changes
- Keep documentation up to date
## Questions?
If you have questions about contributing, feel free to ask in our [Discussions](https://github.com/your-username/hytale-f2p/discussions) or create a [Support Request](.github/ISSUE_TEMPLATE/support_request.yml).
Thank you for contributing to Hytale F2P!