This is the contribute.md of 52°North project Open Sensor Search, sometimes abbreviated to OSS. Great to have you here! Here are a few ways you can help!
Best way to get started is to start with these "quickstart" links. More details can be found in the sections below.
- OSS Wiki: https://wiki.52north.org/bin/view/SensorWeb/OpenSensorSearch
- Sensor Web Community Mailing list: http://sensorweb.forum.52north.org/ (subscribe here)
- IRC channel: #52north on irc.freenode.net
- Background information on discovery in the sensor web: http://52north.org/communities/sensorweb/incubation/discovery/
- General information about contributing to 52°North projects: http://52north.org/about/get-involved/
- Daniel Nüst @nuest
- Mohammad Yakoub, @Moh-Yakoub
- Jan Schulte, @janschulte
- Eike H. Jürrens, @EHJ-52n
- Arne de Wall, @dewall
- Simon Jirka, @simonjirka
52°North requires all contributors to sign a contributors license agreement (CLA). This is not scary but essential for open source projects to live beyond projects and individual contributions.
Find all information on our licensing page at http://52north.org/about/licensing/ and our CLA FAQ at http://52north.org/about/licensing/cla-guidelines.
This section includes advice on how to build new features for the project & what kind of process it includes.
- Before you start working on a new feature, create a new issue and start a discussion on the mailing list.
- We follow the fork & pull development model: https://help.github.com/articles/using-pull-requests
- Use the 52°North code style for Ecplise: https://wiki.52north.org/bin/view/Documentation/WebHome#Software_Development
- Follow the OSS code guidelines: https://wiki.52north.org/bin/view/SensorWeb/OssDevelopment#Development_Process
Don't get discouraged! We estimate that the response time from the maintainers is around 3 days.
You can help report bugs by filing them here: https://github.com/52North/OpenSensorSearch/issues
- Don't forget to check the existing ones first and take a look at the mailing list guidelines - going through these steps makes it likely that you can fix the bug yourself: http://52north.org/resources/mailing-list-and-forums/mailinglist-guidelines
- Look at existing bugs and help us understand if the bug is reproducible. Is it reproducible in other environments (browsers)? What are the steps to reproduce?
All documentation is either in README.md files in each module or in the 52°North wiki, and a critical read as well as feedback and documentation extensions are always welcome.
Documentation for people who want to install and run their own OSS server can be found in the wiki. Just try installing and configuring the software on your system based on the tutorials in the Wiki, let us know what works and what does not, or just go ahead and fix the documentation yourself:
- Installation tutorial: https://wiki.52north.org/bin/view/SensorWeb/OssInstallation
- Configuration: https://wiki.52north.org/bin/view/SensorWeb/OssConfiguration
People who just "use" OSS might need help in using the variety of features. Help is very welcome by exending the user documentation wiki page and also as feedback on the design and structure of the website.
- User documentation: [to be added...]
You can help us making OSS more useful for you by writing your requirements as a user story in the form "As a MY_ROLE, I want MY_GOAL_OR_DESIRE so that A_BENEFIT" and add it as an issue tagged "user story" here: https://github.com/52North/OpenSensorSearch/issues
Tell us about how you use OSS on the community mailing list: http://sensorweb.forum.52north.org/
If you have further questions, contact Daniel: @nuest, [email protected]