Skip to content

Latest commit

 

History

History
45 lines (25 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

45 lines (25 loc) · 2.95 KB
Raw

Contributing to Guild Wars Map Browser

Hello, and thank you for considering contributing to the Guild Wars Map Browser. This project aspires to foster a welcoming, collaborative, and open community. Contributions from both seasoned developers and beginners are highly appreciated.

How to Contribute

There are several key areas where your contributions would be most impactful:

  1. Bug Reporting: Please report any identified bugs in the issue tracker. Include detailed steps to reproduce, any error messages, and screenshots or screen recordings if applicable. Before reporting, ensure the bug hasn't been previously reported. If it has, feel free to add any additional comments or information that might aid in resolution.

  2. Reverse Engineering: Help with reverse engineering is required, particularly with animation, better of blending terrain textures, and more accurately rendering model textures.

  3. 3D Renderer Improvement: Contributions towards making the 3D renderer more efficient, modern, and conforming to better code style are highly appreciated.

  4. Code Reorganization: The project could benefit from code reorganization to enhance readability and performance.

  5. Feature Requests and Other Contributions: If you have a new feature or improvement suggestion, please share it via the issue tracker. Before you start working and submit a pull request, it's recommended to discuss it in the issue tracker to ensure it aligns with the project's goals and avoid unneeded effort.

  6. Testing: Contribute by writing unit tests, performing manual testing, and reporting any bugs to ensure the software's stability.

  7. Documentation: Contributions to the project's documentation, like updates to the README, contributing guidelines, or documenting the .dat file and how to reverse engineer it, are welcomed.

  8. Community: Actively participating in the community is a valuable way to contribute. This could involve answering questions on the issue tracker, participating in design discussions, or assisting newcomers to understand the project.

Submitting Changes

Follow these steps to submit your changes:

  1. Fork the repository on GitHub.
  2. Create a new branch on your forked repository.
  3. Make your changes on this new branch.
  4. Push the changes to your fork.
  5. Submit a pull request to the main branch of the original Guild Wars Map Browser repository.

Please include a descriptive commit message and reference the issue numbers in your pull request.

Code of Conduct

As contributors and maintainers, we're committed to promoting an open and respectful community. Ensure your contributions adhere to this goal. Abusive, harassing, or otherwise unacceptable behavior may result in the rejection of your contribution.

Getting Help

If you're unsure where to start or need help at any point, don't hesitate to ask. Post your queries in the issue tracker.

We're eager to see your contributions and are always here to assist. Happy contributing!