Update main project file to explain the community work and use standardized tools #70

Trim · 2017-08-16T12:34:23Z

Hello,

As 4.0.0-beta4 seems to be enough stable, I took time to update general files (README, install.rdf, ...) to speak more about our project.

I've decided too to remove home made build and translation tools to use standardized tools.
Currently, there's only Makefile which is new for building project.

I'm looking to use translate-toolkit tools (moz2po, po2moz) to use GNU gettext tools for translations.
With such tools, translators will be able to use their own tool and maybe we will be able to use web services like suggested in #52

Please, comment this pull request to add your opinion.
Currently, they are just mines.

mtbc · 2017-08-16T12:37:46Z

CHANGELOG.md

+
+### Known bugs
+- Event/Item editor dialog:
+  - Some times, the HTML editor for task content is freezed and nothing can be edited.


mtbc · 2017-08-16T12:38:25Z

README.md

+  * Lightning extension corresponding to the Thunderbird release
+  * The Exchange server has to provide an Exchange Web Service
+
+This extension was developped by its original author (Michel Verbraak) for


mtbc · 2017-08-16T12:38:52Z

README.md

+This project is a community driven effort to keep maintained and uptodate
+the "Exchange EWS Provider" extension created by Michel Verbraak.
+
+Currently, the community is really small and have too few developpers to


mtbc · 2017-08-16T12:38:59Z

README.md

+
+### Provide feedbak, report issue
+
+You are welcome to provide feedbak on our github project:


mtbc · 2017-08-16T12:39:31Z

README.md

+* For Javascript files, use tabulations to indent your code
+* For XML files, use spaces
+
+That's a bit strange, we know, but its like the original code has been written.


BenjamenMeyer · 2017-08-16T15:23:36Z

README.md

+Exchange 2007, 2010 and 2013.
+
+Now, ExchangeCalendar community try to keep this extension working, but can't
+provide any guarantee on which versions are supported.


grammar, but this would be better as:

The ExchangeCalendar community is now maintaining this extension. Support is best effort and cannot be guaranteed. Contributions are welcome.

Thanks, that's better indeed 👍

BenjamenMeyer · 2017-08-16T15:26:20Z

install.rdf

-    <em:id>exchangecalendar@extensions.1st-setup.nl</em:id>
-    <em:version>4.0.0-beta4</em:version>
+    <em:id>exchangecalendar@ExchangeCalendar</em:id>
+ <em:version>4.0.0-beta5</em:version>


note: it would be neat if this could be a template that could be filled in at build time so the version data, etc could be easily kept in sync.

Now, at build time, the <em:version> line is directly filled with the content of the new VERSION file (that's work of the sed part of the new Makefile). Do you think about something else ?

For the <em:id> part, I am not sure that's a good idea to update it.
Indeed, I think that Thunderbird won't erase older addons (the one from 1st-setup and Ericsson) if we modify it.

PS: Oh, I've just seen that spaces were lost before the <em:version> part, I need to fix the sed command inside the Makefile.

BenjamenMeyer · 2017-08-16T15:28:17Z

@mtbc awesome - thanks for helping standardize this; it'll really help with community growth.

advancingu · 2017-08-17T09:21:01Z

@Trim I'm in the process of setting up a free OSS project account with Transifex for translation management as they offer Mozilla DTD support.

Trim · 2017-08-17T09:55:25Z

Thanks to get in touch with Transifex 👍

Indeed, they say they have DTD support, so we certainly won't need to use the moz2po and po2moz tools.

Let us know if you need help to adapt the repository to the Transifex prerequisites.

Trim · 2017-08-20T07:46:41Z

README.md

+That's a bit strange, we know, but it's like the original code has been written.
+
+As current code indentation is really bad and as we are humans, if you edit a
+file, please first use formatters to automatically have better code indentation:


+As current code indentation is really bad and as we are humans, if you edit a +file, please first use formatters to automatically have better code indentation:

I think that's not correctly translate what I mean. What do you think about the following sentence to replace this one?

The code from the original project is not very well indented and its code style is not consistent. So, when you begin to work on a code that ExchangeCalendar community has not modified recently (you can know this either by looking for last commits date (before August 2017) or by looking the overall indentation and code style), please first use a code beautifier/formatter and commit directly modifications with a message like "auto formatting". Also, with new code, we will be grateful if you can parse your code to such a tool too before sending your patch.

Wouldn't it simply be better to fix all the formatting issues in one big PR by simply iterating over all JS files with a script? This will of course break all first level git-blame investigations but the positive aspect is that all future contributors won't have to worry about existing code and PRs won't be a huge mix of formatting fixes + actual semantic changes.
In other words, I think this project will proceed faster, the easier we make it to contribute.

Yes, indeed, it will help.

The XML formater loose every blank line, but that's then quiet easy to add after files are well structured.

If we do that, we could also:

take decision between space or tab indentation, so every files have same. I'm in favor of spaces fir this eternal question.

move files in a clearer directory scheme (I've seen some xul files inside interface instead of chrome).

Regarding indentation, personally I find space indentation with four spaces much easier to maintain than using tab characters.
As for the folder structure, I've replied to you in the other thread.

advancingu · 2017-08-24T22:04:05Z

@Trim If I did my research right, you should by now have received an email invitation to Transifex as Project maintainer. Could you try to sync the project up so that translations don't have to be transferred manually? I've found their guide for Github here: https://docs.transifex.com/integrations/github

Trim · 2017-08-25T19:44:52Z

Yes, I've well received the invitation. I'm reading the documentation.

Trim · 2017-08-29T14:25:20Z

I had time to understand how Transifex work and to update the exchangecalendar project there.

I just wait we merge the modifications made on Github to update the Readme in this pull request to give link to our Transifex project.

advancingu · 2017-09-12T20:24:02Z

Code is merged now.

…install.rdf Add more informations inside the README and install.rdf files about this community and this project. install.rdf is updated to have heavy version limits on Thunderbird and Seamonkey. Standardize build system with Makefile and VERSION files instead of build.sh The home made translation tools has been deleted, because we'll use a more standardized way with GNU gettext (by use of `moz2po` and `po2moz` tools provided by translate-toolbox).

…cation)

… code will be updated)

Trim · 2017-09-13T16:21:11Z

Ok, I've just rebased my branch with transifex merged code.

Since then, I've added 3 commits which update the README to:

Fix typo in Github name
Update the patching code to remove advises to use beautifiers and add advice about indentation
Update translation section to add Transifex project

You can see these changes herre: https://github.com/ExchangeCalendar/exchangecalendar/pull/70/files/3bfa7acf545f0730b327927b7efa695b2e8ecb8e..31a79bedefee574c4c84d06f41f376b538f7dfaf

Trim · 2017-09-22T22:30:57Z

As this PR is still not merged, I've decided to split it into 3 parts to simplify review process.

If you want to add other comments, please continue discussion on #97 #98 and #99

Trim force-pushed the update-to-community-project branch from 892d6c6 to 761be68 Compare August 16, 2017 12:36

mtbc reviewed Aug 16, 2017

View reviewed changes

README.md Outdated

### Provide feedbak, report issue

You are welcome to provide feedbak on our github project:

Copy link

mtbc Aug 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

feedback

mtbc reviewed Aug 16, 2017

View reviewed changes

Trim force-pushed the update-to-community-project branch from 1789922 to 5157d5f Compare August 16, 2017 13:28

BenjamenMeyer reviewed Aug 16, 2017

View reviewed changes

Trim commented Aug 20, 2017

View reviewed changes

Trim mentioned this pull request Aug 23, 2017

Update code tree #80

Closed

5 tasks

Trim force-pushed the update-to-community-project branch from 04033e8 to a67c4fb Compare September 13, 2017 16:03

Trim added 10 commits September 13, 2017 18:12

fixup English typo

41b9e0f

README.md: add details about js-beautify (add brace option and npm lo…

797ef44

…cation)

README.md: English style update

1a8bc88

Makefile: fix version update inside install.rdf to keep spaces correctly

0dfbe93

Makefile: update beautify part (not used currently, as almost all the…

007d3b9

… code will be updated)

install.rdf: auto update made by make build

3bfa7ac

README.md: fix typo

2d88cee

README.md: update patch the code paragraph (main guidelines)

e81e22f

README.md: update Translation pargraph to target Transifex

31a79be

Trim force-pushed the update-to-community-project branch from a67c4fb to 31a79be Compare September 13, 2017 16:15

This was referenced Sep 22, 2017

install.rdf: update with ExchangeCalendar informations #97

Merged

Clean build and translation tools #98

Merged

Update Changelog with last changes and Readme with more details #99

Merged

Trim closed this Sep 22, 2017

Trim deleted the update-to-community-project branch October 27, 2017 22:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update main project file to explain the community work and use standardized tools #70

Update main project file to explain the community work and use standardized tools #70

Trim commented Aug 16, 2017

mtbc Aug 16, 2017

mtbc Aug 16, 2017

mtbc Aug 16, 2017

mtbc Aug 16, 2017

mtbc Aug 16, 2017

BenjamenMeyer Aug 16, 2017

Trim Aug 16, 2017

BenjamenMeyer Aug 16, 2017

Trim Aug 16, 2017 •

edited

Loading

BenjamenMeyer commented Aug 16, 2017

advancingu commented Aug 17, 2017

Trim commented Aug 17, 2017 •

edited

Loading

Trim Aug 20, 2017

advancingu Aug 21, 2017

Trim Aug 22, 2017

advancingu Aug 24, 2017

advancingu commented Aug 24, 2017

Trim commented Aug 25, 2017

Trim commented Aug 29, 2017

advancingu commented Sep 12, 2017

Trim commented Sep 13, 2017

Trim commented Sep 22, 2017


		### Provide feedbak, report issue

		You are welcome to provide feedbak on our github project:

Update main project file to explain the community work and use standardized tools #70

Update main project file to explain the community work and use standardized tools #70

Conversation

Trim commented Aug 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trim Aug 16, 2017 • edited Loading

Choose a reason for hiding this comment

BenjamenMeyer commented Aug 16, 2017

advancingu commented Aug 17, 2017

Trim commented Aug 17, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

advancingu commented Aug 24, 2017

Trim commented Aug 25, 2017

Trim commented Aug 29, 2017

advancingu commented Sep 12, 2017

Trim commented Sep 13, 2017

Trim commented Sep 22, 2017

Trim Aug 16, 2017 •

edited

Loading

Trim commented Aug 17, 2017 •

edited

Loading