Spatial C++ Library
Generic Multi-Dimensional Containers and Spatial Operations
Contributing

I've noticed a bug...

Please, take a minute to report it here: https://sourceforge.net/p/spatial/tickets/new/. It requires you to log in to Sourceforge or via OpenId. It's not the most convenient approach but it has the benefit of preventing spamming.

I would love if...

You want a new feature? Take a minute to report it here: https://sourceforge.net/p/spatial/feature-requests/new/. It requires you to log in to Sourceforge or via OpenId. It's not the most convenient approach but it has the benefit of preventing spamming.

How can I help?

There are a number of things that can be improved with the library:

  • Documentation is still scarce, any contribution in this regard, no matter how small (gramatical mistakes) makes the library better.
  • Examples are barely there. Any contribution of example source, in particular for something that is not very well documented in the library, is welcomed. The source in question must be well written and the purpose of the example must be stated clearly. It must compile and it is preferable if it is portable. It should not be too large for a reader to understand in a matter of minutes.
  • Support of additional languages: python, .Net, etc. Why not start a project based on one of the tagged version of Spatial and provide support for external languages? Cross-developments between the 2 projects would contribute to make the projects better.
  • Performance improvements, bug fixing...
  • New Features: intrusive containers, cache-oblivious allocators for the containers?

How can I become a contributor?

If you have found an issue and have a fix for it, send it via a patch to the mailing list spati.nosp@m.al-m.nosp@m.ain@l.nosp@m.ists.nosp@m..sour.nosp@m.cefo.nosp@m.rge.n.nosp@m.et. One-time contributions such as these are very helpful. Note that if your fix breaks the current unit tests in the library we might request for your help to fix this together before accepting the patch.

If you wish to become a permanent contributor to the project, annonce your interest on the spati.nosp@m.al-m.nosp@m.ain@l.nosp@m.ists.nosp@m..sour.nosp@m.cefo.nosp@m.rge.n.nosp@m.et. Additionally, you will need to register an account with Sourceforge.net. Once your access is granted, you can use the following command to clone the repository:

$ git clone ssh://your_username@git.code.sf.net/p/spatial/code spatial

What guidelines to follow when contributing?

Follow what the library already does:

  • Do not use CamelCase. Use snake_case. Capitalize the first word of template or large, dominant objects.
  • Private members use _leading underscore. Function parameters may use trailing_ underscores, when functions are large.
  • Do not submit a "patch" if it breaks the unit tests.
  • If you are submitting a new feature, write a unit test for it. Do also provide the related documentation or examples for it.
  • Within the library itself, refrain from add dependancies on non-standard libraries, with the exception of Boost.

Hey this library is cool!

You're satisfied with what you got? Rate us or even write a review for us: http://sourceforge.net/projects/spatial/reviews/