Managing help offers #2178

Merged
merged 5 commits into from Oct 19, 2016

Projects

None yet

3 participants

@mojoaxel
Member

This is trying to fix #2170 and to close #1781

I created a document describing the current maintainer situation (misc/we_need_help.md).

I also added a "HowTo Help" document (misc/how_to_help.md) that describes in detail how to start getting involved in the project.

Also I adapted the CONTRIBUTIONS document and made it clear that general questions should be asked on stackoverflow.

This docs should be a first start and I hope you all keep them up to date and helpfull!

mojoaxel added some commits Oct 18, 2016
@mojoaxel mojoaxel removed reference to the style-guide 78cc13d
@mojoaxel mojoaxel added a how-to-help;
added a document descriping the current maintaner status;
fixes #2170;
closes #1781
ad6d2c8
@mojoaxel
Member

@ludost Can you please have a look at this pull-request. This is clearly in the realm of the maintainer and I want to make sure we are on the same page here!

@ludost ludost was assigned by mojoaxel Oct 18, 2016
@yotamberk

Very clear and well written!

CONTRIBUTING.md
-
-Thanks!
+### Bugs, Problems and Feature-Requests
+If you really want to open a new issue:
@yotamberk
yotamberk Oct 18, 2016 Contributor

First step should probably be something like: "Please check if the question was asked in the open/closed issues"

CONTRIBUTING.md
-Thanks!
+### Bugs, Problems and Feature-Requests
+If you really want to open a new issue:
+* Please make sure to **mention witch module** of vis.js (network, timeline, graph3d, ...) your are referring to.
@yotamberk
yotamberk Oct 18, 2016 Contributor

small misspelling "witch" -> "which"

misc/how_to_help.md
+
+### Provide interesting showcases
+
+If you use vis.js to develop something beautiful feel fee to create a pull-request to our show cases page in the gh-pages branch](//github.com/almende/vis/tree/gh-pages/showcase). [These showcases are displayed on our webpage](http://visjs.org/showcase/index.html) and we are always looking for new examples.
@yotamberk
yotamberk Oct 18, 2016 Contributor

Small typeL fee -> free

@ludost
Member
ludost commented Oct 19, 2016

General approach is excellent. I do wonder if you are already willing to be mentioned in the 'current status' as part of the support team? Something like: a number of people from the user community have been picking up the first work, forming a support team. Currently this team consists of @mojoaxel and @yotamberk . What do you think about this?

Besides the issue tracker and the 'enhancement' label, we might want to create some form of roadmap file as well? This file would be tracking longterm goals in the development. Would something like that be helpful?

On a fully separate note: it has been a long standing irritation that the /dist folder is actually under version control, leading to local changes that should not be committed until a release is done. I like to know if there are examples out there of how to handle this cleaner? This question influences the development flow, that's why I mentioned it now.

But again, great work! I'm glad you are helping eve.js forward!

@mojoaxel
Member

General approach is excellent.

Thanks! I just thought we need to get rid of #1781

I do wonder if you are already willing to be mentioned in the 'current status' as part of the support team?

Why not!

Besides the issue tracker and the 'enhancement' label, we might want to create some form of roadmap file as well? This file would be tracking longterm goals in the development. Would something like that be helpful?

I don't think that is easy. In a community driven project contributors are normally not willing to stick to a roadmap, but contribute what they want, when the want. As far as I'm concerned a roadmap makes only sense almende internal, if you find time to get somebody implementing again.

On a fully separate note: it has been a long standing irritation that the /dist folder is actually under version control, leading to local changes that should not be committed until a release is done. I like to know if there are examples out there of how to handle this cleaner? This question influences the development flow, that's why I mentioned it now.

I'm so with you!! I was already looking into it and could not find an easy solution, yet. I created #2181 for that.

@mojoaxel mojoaxel merged commit f5fe722 into almende:develop Oct 19, 2016
@Bradmoon Bradmoon added a commit to StateFarmIns/vis that referenced this pull request Oct 20, 2016
@Bradmoon Bradmoon Develop - update with master project (#2)
* Added handling of settings backgroundColor and dataColor

* Managing help offers (#2178)

* removed reference to the style-guide
* added a how-to-help; added a document describing the current maintainer status; fixes #2170; closes #1781
* listing the members of the support team
* use search before creating a new issue
* fixes typos

* Added handling of settings for camera

* linked users to there profile

* Add Italian support for timeline

* Added step to defaults; fixes to detect and survive inconstent data

* Adjusted STYLE enum to previous

* Add Italian locale support for network (#2184)

Thanks @federicoco for providing the translation!

* cleaned up locale; added all locals to example; set users local as default

* Added fields tooltip and showLegend to defaults

* Fixed oversight with showTooltip

* Added commond handling for settings with internal prefix 'default'

* Final fixes

* Line graph draw segments by depth order (#2200)

* Updates DataSet and DataView remove event payload (#2189)

* Updates all 'remove' events in DataSet and DataView to include the objects that were removed in addition to the the ids.
* Updated the documentation to reflect changes.
* Fixed possible object mutation when typeof id is object in DataSet.remove.
ea1251e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment