Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 3.17 KB

Contributing Guidelines

Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged! :octocat:

Before opening a new issue/discussion, please try to respect the following rules:

  • Do not open a duplicate issue/discussion! Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests.
  • Prefer using reactions, not comments, if you simply want to "+1" an existing issue.
  • Before creating an issue, check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first.

🪲 Bug Reports and Other Issues

A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report. ✌️ You can report a problem by creating an issue here.

💡 Asking Questions

Need help? Or have a doubt? You can ask on Discord (find the invitation on the main site) or start a new discussion here.

💌 Feature Requests

Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted. We want to avoid feature creep. Your idea may be great, but also out-of-scope for the project. If accepted, we cannot make any commitments regarding the timeline for implementation and release.

You can create a new discussion here, also specify if you want to help with implementation or not.

👨‍🏫 Contribute to the development

Are you a JavaScript/Typescript developer and want to contribute to the project?

You can find a list of pending "features to implement" here.

Or you can apply by creating a thread here, where you introduce yourself and list your expertise.

🔨 Development

Before implementing any kind of change it is recommended to talk to the developers first, in order to get more guidance on how to achieve what you have in mind.

pixi-vn is not a huge project and the code should be quite understandable (apart from the management of Tickers).

The project is divided into the following folders:

  • managers
  • functions
  • classes
  • decorators
  • interface
  • types
  • labels
  • pixi-devtools

To export "elements" making them available to developers using this library they must be exported to index.ts files.

(This procedure is being improved) To give you the possibility to test and debug your work you can use the following project: https://github.com/DRincs-Productions/pixi-vn-tester