Some guidelines on contribution to TNeo.
Contribution
So you want to contribute to the kernel. That's really cool! Then, please consider the following:
- Please contact me first (mail@.nosp@m.dmit.nosp@m.ryfra.nosp@m.nk.c.nosp@m.om is probably the best), so that we can discuss changes you're going to implement and ways to do that. It is really important to understand each other well, before actual work is done;
- If you don't have an account on bitbucket.org yet, create it;
- Fork TNeo repository on bitbucket;
- Perform needed changes in your own fork;
- Create a pull request to main repository;
- Your changes get merged into main TNeo repository. You're done, thanks! Now, you're free to delete your fork or keep it, as you wish.
Coding standard
I don't have much to say on this topic. The most important and universal thing is: please see as other code is written and write in a similar manner.
As an addition, I just want to emphasize several aspects that are often a subject to forget:
- Set your editor so that it doesn't use tabs, use exactly 3 spaces for indentation. By the way, you're encouraged to read my article Indent with tabs, align with spaces, which explains how to use tabs properly. I really like the idea, but at the moment editors are unfortunately too dumb to follow these guidelines, and people (including me) generally aren't ready to maintain these conventions manually, so, at least for now, the easiest and practical solution is to just use spaces only.
- When you add or change something observable, explain it in Changelog.
- Don't forget to write comments so that doxygen can parse them. You don't have to learn doxygen manual for that, just look as others comments are written.
- When you add new kernel option (to the file
tn_cfg_default.h), modify tn_cfg_dispatch.h as well: add a check that option macro is defined.
And thank you for contribution!
