Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.

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

Closed
wants to merge 10 commits into from
Closed

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

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5d408cd
Clean meta data and tools on the project: README, Makefile, VERSION, …
Trim Aug 16, 2017
41b9e0f
fixup English typo
Trim Aug 16, 2017
797ef44
README.md: add details about js-beautify (add brace option and npm lo…
Trim Aug 16, 2017
1a8bc88
README.md: English style update
Trim Aug 16, 2017
0dfbe93
Makefile: fix version update inside install.rdf to keep spaces correctly
Trim Aug 16, 2017
007d3b9
Makefile: update beautify part (not used currently, as almost all the…
Trim Aug 16, 2017
3bfa7ac
install.rdf: auto update made by make build
Trim Aug 16, 2017
2d88cee
README.md: fix typo
Trim Aug 29, 2017
e81e22f
README.md: update patch the code paragraph (main guidelines)
Trim Aug 29, 2017
31a79be
README.md: update Translation pargraph to target Transifex
Trim Aug 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup English typo
  • Loading branch information
@Trim
Trim committed Sep 13, 2017
commit 41b9e0fe127067ac5e5966bf9c66a66d3dbbf17c
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -45,7 +45,7 @@ All notable changes to this project will be documented in this file.

### Known bugs
- Event/Item editor dialog:
- Some times, the HTML editor for task content is freezed and nothing can be edited.
- Some times, the HTML editor for task content is frozen and nothing can be edited.
A workaround is to close the task and open it again.


10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ This extension requires:
* 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
This extension was developed by its original author (Michel Verbraak) for
Exchange 2007, 2010 and 2013.

Now, ExchangeCalendar community try to keep this extension working, but can't
@@ -31,12 +31,12 @@ This add-on is open source and based on the work of many
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
Currently, the community is really small and have too few developers to
give any warranty on the future. Please help us to continue this project.

### Provide feedbak, report issue
### Provide feedback, report issue

You are welcome to provide feedbak on our github project:
You are welcome to provide feedback on our github project:
https://github.com/ExchangeCalendar/exchangecalendar

Please note that the project is built only for latest stable Thunderbird release
@@ -75,7 +75,7 @@ To help us to maintain the code, we will be thankful to follow these guidelines:
* 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.
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:
Copy link
Member Author

Choose a reason for hiding this comment

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

+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.

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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).

Copy link
Member

Choose a reason for hiding this comment

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

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.

4 changes: 2 additions & 2 deletions install.rdf
View file
Original file line number Diff line number Diff line change
@@ -43,13 +43,13 @@ This extension requires:
* 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
This extension was developed by its original author (Michel Verbraak) for
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.

You are welcome to provide feedbak on our github project:
You are welcome to provide feedback on our github project:
https://github.com/ExchangeCalendar/exchangecalendar

Some of the icons and images used are from the Fugue Icons Collection made by Yusuke Kamiyamane (http://p.yusukekamiyamane.com/)