Contributions and Feature Requests - tomboy-notes/tomboy-ng GitHub Wiki

Contributions-and-Feature-Requests

Pull Requests

If you would like to make a direct contribution to tomboy-ng via a pull request, its likely to be well received. But please note the following -

  • License - As of October 2020, tomboy-ng has a very liberal license and thats to ensure easy entry in things like Debian. Debian and similar organizations have very strict rules about ensuring copyright holders wishes are observed, so its necessary to prevent the copyright becoming too fractured. By making a contribution to tomboy-ng, you agree to assign any copyright to David Bannon, unless the contribution is such that we agree otherwise. In either case, you contribution, if accepted, will be acknowledged and you may be listed as an author.

  • When creating a pull request, make sure it targets just one specific bug or feature and makes the minimum changes necessary to achieve what you are trying to do. Try to avoid making changes to more files than absolutely necessary. Wide ranging changes require extensive testing on the multiple platforms that tomboy-ng supports.

  • Consider discussing your proposed changes via the tomboy-ng issues page before investing a lot of blood, sweat and tears !

Feature Requests

You are very welcome to submit requests for new or improved features in tomboy-ng. If you have a github account (its free) create or add to an issue here, else, please send me an email to the address listed in the tomboy-ng install kits.

Here I will mention a number of possible additions and some superficial comments, don't let my comments prevent you from 'voting' for something, listed or not !

Encryption

If you sync your notes to some site outside your control, or even just have nosey family members, maybe you need encryped notes ? The downside might be making searching harder/slower. Would you want the whole note encrypted or just key words, sentences ?

Embedded Images

Do you want to have pretty pictures in your notes, if so, what format would you want ?

Net Sync

By netsync, I mean to dedicated servers like Snowy, Rainy or, more practicable today, a grauphel/NextCloud/Apache stack. A not inconsiderable effort to install such a stack but do you really need it ? ( Be aware that tomboy-ng will now, very easily, sync to any remote server you can ssh to. )

And perhaps v0.34's ability to sync and then display (and edit) your notes online, via Github, on any device with a browser solves this problem ?

Database

Move notes into database (ie sqlite for small users, something bigger for BIG users). tomboy-ng now does multithreaded indexing of notes, my tests indicate that there is little to be gained.

Spell Check while you type

You know, badly spelt words are somehow highlighted as you type. I know I have some very fast typists out there, I am not sure I can keep up with them.

⚠️ **GitHub.com Fallback** ⚠️