search

mbilker / cypher

:closed_lock_with_key: N1 PGP package
GNU General Public License v3.0
130 stars 12 forks source link

Need help? #3

Closed mxstbr closed 8 years ago

mxstbr commented 8 years ago

I just discovered this plugin and I love it!

I'd like to help out, I'm a privacy geek and a JavaScript dev. Can you compile a roadmap, or some sort of starter issue list I could tackle?

Awesome work so far!

EDIT: Also, a CONTRIBUTING.md and a first release would be nice to know how to install it/try out the beta for working on it.

mbilker commented 8 years ago

Yes, I do need help. I will make a roadmap for a milestone.

mbilker commented 8 years ago

Alright. I am making some changes to the layout of the plugin. I will develop the CONTRIBUTING.md file so it becomes a better representation. Also, I need to add the GPLv3 because of N1 licensing.

mxstbr commented 8 years ago

Awesome! Let me know when it's ready and I can get started!

mbilker commented 8 years ago

To let you know. I am also in the process of documenting the code using JSDoc, which the Nylas team is trying to use with new components.

mbilker commented 8 years ago

I added a basic roadmap at https://github.com/mbilker/cypher/blob/master/ROADMAP.md

mxstbr commented 8 years ago

Awesome! Could you explain how one works on an N1 plugin? How do I download and install it so I can change things and see them reflected in my N1 instance?

mbilker commented 8 years ago

Sure thing. The way how I work on this or any N1 plugin is clone the repository in ~/.nylas/dev/packages. Then start N1 with Debug flags or developer mode. This is done through Developer -> Run with Debug Flags from the menu bar.

Whenever I make a change, I run eslint to ensure I have a variable defined. That issue bites my back everytime I forget to define a variable correctly. I then restart N1 by using Ctrl + Q to fully exit N1. Closing the window does not suffice as N1 continues to run in the background.

mxstbr commented 8 years ago

:+1: Awesome, thanks!

mbilker commented 8 years ago

Just so you know: I build my own N1 from the GitHub release. If you decide to do the same, I have some precautions. The open-source build does not include the fonts, analytics, or sounds.

mxstbr commented 8 years ago

What's the benefit of doing that for development, or do you do it out of privacy concerns?

mbilker commented 8 years ago

I actually add them back in, but I did take a look at the analytics they take in. The analytics are not bad at all. I do it to get the latest features and fix bugs on their end.