User Tools

Site Tools


fs_how_to_be_a_good_neighbor
Advertisement

How to be a Good Development Neighbor

Intro

Firestorm publishes our source code open source under the LGPL license for others to review, use, and improve. We've tried to make it as easy as possible to get involved and help make improvements. We believe that the more people work together, the faster the progress. We hope that people will contribute directly, but we're also happy when our work is reused in other new places. We hope that when people use our code in other projects they will do a few simple things that allow us to collaborate for mutual benefit.

Communication

If you're planning to use Firestorm's code in another project, please do contact us and say “hello”! It's good to know other people that may be able to answer particular questions, may have specific areas of expertise, or may otherwise be able to collaborate in new ways. We also might be able to provide additional information of interest to your project beyond what's on our wiki and code repository. You can email us at admin@phoenixviewer.com.

Credits

Credits are very important to open source developers! We would like to make sure we fully credit authors whose code we use, and hope that others will do the same.

If you use Firestorm's code, please make sure you preserve credits for the specific original author. The preferred way to do this would be:

  • If there's a copyright © notice in the code you're using, please do not remove any part of the copyright line.
  • If your project has a help/about window popup, please list the author there, otherwise list it in the places where you would normally list credits.
  • If your project has a code repository, mention the original author in the appropriate commit message.
  • If you use a Firestorm-derived feature and prominently mention the feature in promotional interview, journalist piece, web info page, or similar publication, please mention the original author.

If you can't determine the original author, ask us and we'll help you find out. Please do not just say “Firestorm” in your credits, always use the actual author's preferred name of record. It's polite, but not required, to also add “(Firestorm)” after the author's name if that code came from the project's source respositories.

We strive to follow the same guidelines with respect to other authors and other projects. If you have corrections or suggestions, please create a ticket at jira.phoenixviewer.com.

Licensing

Firestorm uses Linden Lab's snowstorm repository under the LGPL license, and publishes our own code under the LGPL license in return. Similarly, many other snowstorm-based third party viewer projects also share their code under the LGPL so that we can share and maximally take advantage of each other's work.

We hope this convention continues, and projects that use our code will also choose to share back their work under the same license so others may benefit.

Unreleased Features

Firestorm makes our in-development repository public. However, we request that none of the in-development, unreleased features are copied from our repository and released elsewhere ahead of our release schedule, without permission. Generally if we are developing a new feature that doesn't exist anywhere, please don't copy our own code and release it ahead of us. We have agreements with other major third party viewer projects that we won't do this to each other.

If you don't know if a feature has been released or not, check the contents of /indra/VERSION in the respository at the time the feature was added. If the version number here is higher than our released binaries on www.phoenixviewer.com, the feature is still in-development. You can also ask anyone on our team, which is a nice practice anyway.

Commit History

If your project has a public source code repository and you're using Firestorm code, we'd appreciate if you commit Firestorm-derived changesets in a way that is clearly labelled. This helps us better find any interesting, useful improvements that you might have made, or just have another example of how the code can be used.

Artwork

Please don't call your project something so similar to Firestorm that people would think our projects are related. Likewise, please don't use Firestorm icon logos in your projects.

Good Luck

Good luck, development neighbor! We hope to see you around!

fs_how_to_be_a_good_neighbor.txt · Last modified: 2017/08/21 19:23 by anastasia.horngold