Skip to content

Commit

Permalink
Call for (Co-)Maintainer (#152)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jkozera
jkozera committed Jan 2, 2015
1 parent aaa5dff commit f07ca1b
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Zeal

## Call for (Co-)Maintainer

**Please contact me via email (available in git commits) if you are interested in taking over or co-maintaining this project.** I could transfer it to a different account, perhaps even transfer the zealdocs.org domain if someone is interested. Anyone with relevant C++ and Qt experience is encouraged to apply!

[![Build Status](https://api.shippable.com/projects/5475304bd46935d5fbbe9b81/badge?branchName=master)](https://app.shippable.com/projects/5475304bd46935d5fbbe9b81/builds/latest)
(latest builds are available at https://bitbucket.org/jerzykozera/zeal-win32-binary-downloads/downloads)

---

**zeal**
*noun*

Expand All @@ -18,6 +24,17 @@ Zeal is a simple documentation browser inspired by [Dash](http://kapeli.com/dash

[More screenshots (imgur)](http://imgur.com/a/eVi97)

## Project Status

This project is not under active development at the moment, so unless someone is interested in maintaining it, no new features or fixes are expected.

## Contributions

Pull requests may remain not reviewed for long time, and in general I don't foresee having much time for this project.

Please keep in mind I'm not an experienced C++ programmer, so the code quality might be not great.


## Download

For details about binary packages (currently available for Windows and Ubuntu) see [downloads page](http://zealdocs.org/download.html).
Expand Down Expand Up @@ -68,11 +85,3 @@ If you prefer, you can start with Zeal queries from command line, for this, use
## Creating your own docsets

You can use [Dash's instructions for generating docsets](http://kapeli.com/docsets).

## Contributions / Project Status

Any feedback, feature requests, or pull requests are welcome. However the project is not under active development at the moment, so unless someone is interested in contributing code, no new features are expected.

I'm going to continue updating docsets that are part of Dash/Zeal exchange programme, and try to fix critical stability/compatibility issues if any arise, to keep the project somewhat alive, but will not implement new features in foreseeable future. Anyway, I should be able to review pull requests.

Please keep in mind I'm not an experienced C++ programmer, so the code quality might be not great.

2 comments on commit f07ca1b

@spacewander
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi，@jkozera, I am willing to apply to be a co-maintainer!

  1. Being a college student, I can have some spare time to maintain Zeal, including writing new feature and reviewing pull request.
  2. I have been using both C++ and Qt for two years. Though I have not been proficient in C++ yet, I will do my best.
  3. I am a fan of FOSS, and have a strong interest to contribute to them.

I am looking forward to your reply.

@jkozera
Copy link
Member Author

@jkozera jkozera commented on f07ca1b Jan 3, 2015

Choose a reason for hiding this comment

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

Thank you! I've just made you a collaborator so you can merge pull requests. Let me know if you have any questions.

About your #243, it looks like a good change, but to be honest I'm too confused by the number of various cases to handle to review it completely, but if you think your change is still useful, feel free to merge it yourself.

By various cases I mean:

  1. What if reply->error() != QNetworkReply::NoError? It will still show an error message ("Failed retrieving
    list of docsets"), won't it?
  2. availMetadata.clear(); called and another message box created in case of some weird failure: !docset[1].startsWith("http") - would it ever happen? I know I've added this check myself in 8a66b33 but honestly I don't remember why. Maybe it should be removed. clear()ing the list can make it empty even if the download from kapeli.com succeeded, so it looks wrong, so even if this case ever happens, I wouldn't do clear() there, and wouldn't show the error message anyway unless both downloads fail.

So basically your change is good, but seems like it could be incomplete and not fix all the issues - hence I was hesitating if I should merge it.

Please sign in to comment.