Skip to content

Instantly share code, notes, and snippets.

@nuest

nuest/contribute.md

Last active August 29, 2015 14:17
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save nuest/4b6d60ec0d8fd3b6a930 to your computer and use it in GitHub Desktop.
Save nuest/4b6d60ec0d8fd3b6a930 to your computer and use it in GitHub Desktop.
Download ZIP
ows.js contribute.md
Raw
contribute.md

This is the contribute.md of the project ows.js. Great to have you here! Here are a few ways you can help!

Contribute.md

This page describes what you need to know to contribute code to ol3 as a developer, documenter or bug reporter.

Contributing Code

Our preferred means of receiving contributions is through pull requests since we use the fork & pull development model. Make sure that your pull request follows our pull request guidelines below before submitting it.

To start the development, fork the repository and check out the README.md for help to set up your development environment.

Learn & listen

Best way to get started is to get to know the following means of communication:

Team Members

See https://github.com/OSGeo/ows.js/graphs/contributors

Adding new features

This section includes advice on how to build new features for the project & what kind of process it includes.

  • This is how we like people to add new features: Get in touch with the developers on the mailing list (see above) and describe your use case/requirements.
  • Here are some specifics on the coding style we prefer: DO WE HAVE ANY?
  • You should include the following tests: We use QUnit for testing and you should add unit tests to the directory /test in the respective service's test file.
  • These are the updates we hope you make to the changelog: Briefly describe the new functionality as part of the current development versions "Features" section.

Don't get discouraged! We estimate that the response time from the maintainers is around 2 to 3 days.

Bug triage

This sections explains how bug triaging is done.

  • First go through the existing bugs here and check if a related bug is already filed. If that is the case, try to clarify or confirm the behaviour from your perspective.
  • https://github.com/OSGeo/ows.js/issues/new
  • 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?
  • You can close fixed bugs by testing old tickets to see if they are still happening
  • You can remove duplicate bug reports

Beta testing

ows.js is still a very young project, so everything that you will do qualifies as beta testing and we highly appreciate your efforts to help us improving the code.

You can find the roadmap and features that are known to require further testing from here: TBD

Documentation

Developer documentation is done as markdown files within the source code, most notably the file README.md in the project root. General user documentation can be found in the GitHub wiki and API documentation ... TBD

Community

ows.js is a project under the OSGeo umbrella. Even if you are not a developer you can advance the project by...

  • use the library for projects in the real world,
  • answering questions our users have on the mailing list,
  • helping to build and design our website,
  • writing blog posts about the project and sharing your or other peoples experiences (e.g. including screenshots and videos), and
  • let us know your requirements as new issues.
  • If you have further questions, contact owsjs@lists.osgeo.org
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment