🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
2.4 KiB

  1. # Contributing
  2. First of all, thank you very much for taking the time to contribute to the
  3. `EnTT` library.<br/>
  4. How to do it mostly depends on the type of contribution:
  5. * If you have a question, **please** ensure there isn't already an answer for
  6. you by searching on GitHub under
  7. [issues](https://github.com/skypjack/entt/issues). Do not forget to search
  8. also through the closed ones. If you are unable to find a proper answer, feel
  9. free to [open a new issue](https://github.com/skypjack/entt/issues/new).
  10. Usually, questions are marked as such and closed in a few days.
  11. * If you want to fix a typo in the inline documentation or in the README file,
  12. if you want to add some new sections or if you want to help me with the
  13. language by reviewing what I wrote so far (I'm not a native speaker after
  14. all), **please** open a new
  15. [pull request](https://github.com/skypjack/entt/pulls) with your changes.
  16. * If you found a bug, **please** ensure there isn't already an answer for you by
  17. searching on GitHub under [issues](https://github.com/skypjack/entt/issues).
  18. If you are unable to find an open issue addressing the problem, feel free to
  19. [open a new one](https://github.com/skypjack/entt/issues/new). **Please**, do
  20. not forget to carefully describe how to reproduce the problem, then add all
  21. the information about the system on which you are experiencing it and point
  22. out the version of `EnTT` you are using (tag or commit).
  23. * If you found a bug and you wrote a patch to fix it, open a new
  24. [pull request](https://github.com/skypjack/entt/pulls) with your code.
  25. **Please**, add some tests to avoid regressions in future if possible, it
  26. would be really appreciated. Note that the `EnTT` library has a
  27. [coverage at 100%](https://coveralls.io/github/skypjack/entt?branch=master)
  28. (at least it was at 100% at the time I wrote this file) and this is the reason
  29. for which you can be confident with using it in a production environment.
  30. * If you want to propose a new feature and you know how to code it, **please**
  31. do not issue directly a pull request. Before to do it,
  32. [create a new issue](https://github.com/skypjack/entt/issues/new) to discuss
  33. your proposal. Other users could be interested in your idea and the discussion
  34. that will follow can refine it and therefore give us a better solution.
  35. * If you want to request a new feature, I'm available for hiring. Take a look at
  36. [my profile](https://github.com/skypjack) and feel free to write me.