Welcome to puny2d!
If you intend to contribute to this project, please read following text carefully to avoid bad misunderstandings and wasted work. Contributions are appreciated but just under correct terms.
Please start by reading our license and code-of-conduct. If you don't agree with them, this isn't your project.
Before planning to post issues or request pulls, have a look at our templates:
For further questions, visit our discord chat.
- We're mentoring but just to a certain degree. An initial effort should have been done, training in programming basics or computer science isn't part of the offer. We want to speed up development, not slowing it down.
- Quality has priority, not getting fastly done. Faults by unnecessary hurry or sentences like "at least it works" are the opposite of "being welcome" here. Putting experiments on users is disrespectful for their time investment.
- Don't get emotional, act logical. Personal taste has to back off if there's no explanation why xy makes more sense for others too. Let's combine the best of all!
- Comment & document your changes. Keep in mind others may work on same project parts too and don't want to spend much time understanding what you've done. 10 seconds you saved costs another contributor 10 minutes.
- Contributing should happen as teamwork, not as competition. Join discussions, look through PRs and issues, merge compatible forks. Ignoring the progress of others leads to lost time (and motivation).
- Nothing comes through untested! Try to add tests for critical parts and at least 50%.
- Comment enough to leave no questions. In a perfect world code explains himself - spoiler: we don't live in a perfect world!
- You remember KISS? Less code = less maintenance effort. Keep your code clean (no zombies), optimize by a worthy cost-benefit balance and use standards instead of bloating with dependencies!
- Auto-format doesn't always result in most readable code! Review and format for humans.
- Continue present conventions and follow best practices. Don't break our pattern, code needs no multi-culture.
- Trust in compiler warnings and clippy suggestions. They mostly know better than you how good code looks like. Edit until your tools stop complaining.
- Bugfixes
- Feature ideas
- Tools (editors, plugins, pre- & post-processors, ...)
- Tutorials
Main contribution ways are to open issues and fork with later pull requests.
Furthermore you can discuss issues, review PRs, develop supportive software, mention this project in public or chat with the community about your experience.
The community has a high value for this project!
As much as possible should be discussed in public, important decisions made by multiple individuals and people not getting excluded just because of a little dispute.
Those who actively contribute and follow the spirit of open source development get the chance to become organization members.