Files
hytale-f2p-mirror/.github/CONTRIBUTING.md
sanasol a2b60ba3a0 docs: deprecate Hytale-F2P in favor of F2P Evo
Replace README with short deprecation notice pointing to f2p-evo.
Add deprecation headers to SERVER.md, TROUBLESHOOTING.md, server/README.md.
Remove CloudNord advertising, buymeacoffee links, and Discord references.
Update Docker URLs from Hybrowse to sanasol, fix contact links.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-11 00:23:57 +01:00

2.3 KiB

Note: This project has been superseded by F2P Evo. Please contribute to the new project instead.

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.

How to Contribute

Reporting Bugs

  • Use the Bug Report 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 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
  • 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, join our Community Chat or TG Group.

Thank you for contributing to Hytale F2P!