This repository has been archived by the owner on Jul 29, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
23 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,3 @@ | ||
| This project is no longer in active development. See #4259 for details. | ||
|
|
||
| Please make sure to **read the following list** before creating a new issue: | ||
|
|
||
| * This issue tracker is not supposed to be used for questions on how to use visjs. It is intended to be used for bug reports and feature requests! In case you face yourself with a usage question, then post your question e.g. on [stackoverflow](https://stackoverflow.com/questions/tagged/vis.js) tagged with "vis.js". | ||
| * Have you already used the [github search](https://github.com/almende/vis/issues), read the [documentation](http://visjs.org/) and looked at the [examples](https://github.com/almende/vis/tree/develop/examples)? | ||
| * Make sure to mention which vis-component (network, timeline, graph2D, graph3d) you are referring to. | ||
| * Make sure to use the [latest version of vis.js](https://cdnjs.com/libraries/vis) for bug reports. | ||
| * Make sure to mention which browser and OS you are using when creating a bug report. | ||
| * Please provide a minimal code example that demonstrates your issue. We recommend using [jsbin](jsbin.com) for that. | ||
| * Delete this list from the actual issue. | ||
| Please contribute to the [visjs community](https://github.com/visjs)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,3 @@ | ||
| **Thank you for contributing to vis.js!!** | ||
| This project is no longer in active development. See #4259 for details. | ||
|
|
||
| Please make sure to check the following requirements before creating a pull request: | ||
|
|
||
| * [ ] All pull requests must be to the [develop branch](https://github.com/almende/vis/tree/develop). Pull requests to the `master` branch will be closed! | ||
| * [ ] Make sure your changes are based on the latest version of the [develop branch](https://github.com/almende/vis/tree/develop). (Use e.g. `git fetch && git rebase origin develop` to update your feature branch). | ||
| * [ ] Provide an additional or update an example to demonstrate your changes or new features. | ||
| * [ ] Update the documentation if you introduced new behavior or changed existing behavior. | ||
| * [ ] Reference issue numbers of issues that your pull request addresses. (If you write something like `fixes #1781` in your git commit message this issue gets closed automatically by merging your pull request). | ||
| * [ ] Expect review comments and change requests by reviewer. | ||
| * [ ] Delete this checklist from your pull request. | ||
| Please contribute to the [visjs community](https://github.com/visjs)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,5 @@ | ||
| ## Contributing | ||
| # Contributing | ||
|
|
||
| [Contributions](//github.com/almende/vis/blob/master/misc/how_to_help.md) to the vis.js library are very welcome! [We can't do this alone](//github.com/almende/vis/blob/master/misc/we_need_help.md). | ||
| This project is no longer in active development. See #4259 for details. | ||
|
|
||
| ### Questions | ||
| If you have any *general question* on how to use the vis.js library in your own project please check out [stackoverflow](http://stackoverflow.com/questions/tagged/vis.js) for thinks like that. **This is NOT a JavaScript help forum!** | ||
|
|
||
| ### Bugs, Problems and Feature-Requests | ||
| If you really want to open a new issue: | ||
| * Please use the [search functionality](//github.com/almende/vis/issues) to make sure that there is not already an issue concerning the same topic. | ||
| * Please make sure to **mention which module** of vis.js (network, timeline, graph3d, ...) your are referring to. | ||
| * Note that development happens on the `develop` git branch. Be sure to submit PRs against this branch. | ||
| * If you think you found a bug please **provide a simple example** (e.g. on [jsbin](jsbin.com)) that demonstrates the problem. | ||
| * If you want to propose a feature-request please **describe what you are looking for in detail**, ideally providing a screenshot, drawing or something similar. | ||
| * **Close the issue later**, when the issue is no longer needed. | ||
| Please consider contributing to the [visjs community](https://github.com/visjs)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,5 @@ | ||
| # HowTo Help | ||
| # How to help! | ||
|
|
||
| The company that developed vis.js for the main part, *almende* is [not able to maintain the project at the moment](./we_need_help.md). So help from the community is very needed and welcome! | ||
| This project is no longer in active development. See #4259 for details. | ||
|
|
||
| ## There are many ways to help: | ||
|
|
||
| ### Answering questions | ||
|
|
||
| There are new [issues with questions](//github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+label%3AQuestion+sort%3Acreated-desc) how to use vis.js opened almost every day. Be part of the community and help answer them! | ||
|
|
||
| A better way to ask questions on how to use vis.js is [stackoverflow](https://stackoverflow.com/tags/vis.js). Questions are posed here also and need to be answered by the community. [Please help answering questions](https://stackoverflow.com/tags/vis.js) here also. | ||
|
|
||
| ### Closing old issues | ||
|
|
||
| A new issue is often opened fast and then forgotten. Please help go through [the old issues](//github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-asc) (especially the [questions](//github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-asc+label%3AQuestion)) and ask the creator of the issues if the problem still exists before closing the issue. The support team uses the **issue inactive** label to mark these issues. | ||
|
|
||
| ### Improve the webpage | ||
|
|
||
| The visjs.org webpage is hosted on the [gh-pages branch](//github.com/almende/vis/tree/gh-pages). If you find a typo or anything else that should be improved feel free to create a pull-request to *gh-pages*. Please make changes in your own fork of gh-pages so the support team can view the changes in your hosted fork. | ||
|
|
||
| ### Create new examples | ||
|
|
||
| We have [a collection of examples](//github.com/almende/vis/tree/develop/examples). Please help by creating interesting new ones that show a specific problem or layout. Keep the examples easy to understand for beginners and remove unnecessary clutter. | ||
|
|
||
| ### Provide interesting showcases | ||
|
|
||
| If you use vis.js to develop something beautiful feel free 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. | ||
|
|
||
| ### Confirming and fixing bugs | ||
|
|
||
| Every software has bugs. We also have [quite a nice collection](https://github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+label%3ABug+sort%3Areactions-%2B1-desc) ;-) | ||
| Feel free to fix as many bugs as you want! | ||
|
|
||
| You can not only help by fixing bugs, but also by confirming the bug or even creating a minimal code example to prove this bug exists. | ||
|
|
||
| ### Implementing Feature-Requests | ||
|
|
||
| A lot of people have a lot of ideas for improving vis.js. [We label these issues as **Feature-Request**](https://github.com/almende/vis/labels/Feature-Request). Feel free to implement a new feature by creating a new Pull-Request. | ||
|
|
||
| [Some issues are labeled **For everybody!**](//github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+label%3A%22For+everyone%21%22+sort%3Areactions-%2B1-desc). These are a good starting point. | ||
|
|
||
| ### Reviewing Pull-Requests | ||
|
|
||
| We use [GitHub's two-step review](//help.github.com/articles/about-pull-request-reviews/) to make sure pull-requests are clean. You can help by checking out pull-request branches and testing them. You also can comment on lines of code and make sure the pull-request introduces no new bugs or typos. | ||
|
|
||
| ## Creating Pull Requests | ||
|
|
||
| There are some rules for pull-request: | ||
|
|
||
| * All pull-request must be to the [develop-branch](//github.com/almende/vis/tree/develop). Pull-request against the [master-branch](//github.com/almende/vis/tree/master) must be closed. (Changes to [gh-pages](//github.com/almende/vis/tree/gh-pages) are also ok.) | ||
|
|
||
| * Only commit changes done in the source files in the folder `lib`, not to the builds | ||
| which are located in the folder `dist`. | ||
|
|
||
| * Keep your changes small and clear. Only work on one topic at one time and only change lines of code that you have to change to reach your goal. | ||
|
|
||
| * Test your changes before creating a pull-request. The easiest way is to open the existing examples and playing with them. | ||
|
|
||
| * If you are fixing or implementing an existing issue, please refer to it in the description and in the commit message. | ||
|
|
||
| * If you are introducing a new feature, add some documentation and a new example to make it easy to adapt. | ||
|
|
||
| * If you introduce breaking changes, like changing the signature of a public function, point that out in your description. Breaking changes result in a new major release. | ||
|
|
||
| * Always adapt to the code style of the existing source. Never adapt existing code to your personal taste. :trollface: | ||
|
|
||
| * Pull-requests must be reviewed by at least two member of the support team. The First must approve the pull-request, the second can than merge after also checking it. | ||
|
|
||
| **Happy Helping!!** | ||
| Please consider contributing to the [visjs community](https://github.com/visjs)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,5 @@ | ||
| # We need help! | ||
|
|
||
| ## The current status | ||
| This project is no longer in active development. See #4259 for details. | ||
|
|
||
| Vis.js is looking for people who can help maintain and improve the library. We've put a lot of effort in building these visualizations, fixing bugs, and supporting users as much as we can. For some time now, we’ve been lacking the manpower to maintain the library the way we have in recent years. [@josdejong](//github.com/josdejong) has left the company for a new opportunity, and [@AlexDM0](//github.com/AlexDM0) has moved internally to a daughter company, with severe impact on his time and availability for Vis.js. At the moment [@ludost](//github.com/ludost) is the official maintainer from Almende, but does not have much time to help out. | ||
|
|
||
| Although Almende is looking to replace the expertise required for Vis.js, we don't expect to be able to do comprehensive project management any time soon. At the same time we’d like to spare Vis.js from becoming abandonware, especially given the relative healthy user base. For the longer term future we would be happy if vis.js could stand on its own feet, community supported. | ||
|
|
||
| **If you want to support the project please just start by [helping out](./how_to_help.md).** | ||
|
|
||
| If you have shown some commitment to the project you can ask [@ludost](//github.com/ludost) to become a member of the community support team. This team has write permissions to the repository and is helping maintaining it. Currently this team consists of: | ||
|
|
||
| * [@ludost](//github.com/ludost) (almende maintainer) | ||
| * [@mojoaxel](//github.com/mojoaxel) | ||
| * [@yotamberk](//github.com/yotamberk) | ||
| * [@Tooa](//github.com/Tooa) | ||
| * [@eymiha](//github.com/eymiha) | ||
| * [@bradh](//github.com/bradh) | ||
| * [@wimrijnders](//github.com/wimrijnders) | ||
| * [@macleodbroad-wf](//github.com/macleodbroad-wf) | ||
| Please consider contributing to the [visjs community](https://github.com/visjs)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters