Skip to content
Snippets Groups Projects
Commit 1c8dae7d authored by Jonathan Wilkes's avatar Jonathan Wilkes
Browse files

improve contributor guide to accommodate newcomers with easy bugfixes

parent 2aa4623e
No related branches found
No related tags found
1 merge request!169improve contributor guide
Pipeline #
...@@ -259,22 +259,30 @@ Contributing is easy: ...@@ -259,22 +259,30 @@ Contributing is easy:
1. Join the development list: 1. Join the development list:
http://disis.music.vt.edu/cgi-bin/mailman/listinfo/l2ork-dev http://disis.music.vt.edu/cgi-bin/mailman/listinfo/l2ork-dev
2. Tell us what you'd like to work on. There are lots of possibilities. For 2. Fork Purr Data using the gitlab UI and then try to build it from source
example, there are _lots_ of externals and even core features that are for your own platform using the [Build Guide](#build-guide) above.
poorly documented. If you run into problems ask on the development list for help.
3. _No prototypes, please_. Purr Data's biggest strength is that users can 3. Once you have successfully built Purr Data, install it and make sure it
turn an idea into working code very quickly. But a prototyping language that runs correctly.
is itself a prototype isn't very useful. That means Purr Data's core code 4. Start making changes to the code with brief, clear commit messages. If you
and libraries must be stable, consistent, well-documented, and easy to use. want some practice you can try fixing one of the bugs on the issue tracker
4. Develop incrementally. Small, solid improvements to the software are labeled
preferable to large, disruptive ones. ["good-first-bug"](https://git.purrdata.net/jwilkes/purr-data/issues?label_name%5B%5D=good-first-bug)
5. Make sure you aren't duplicating existing functionality, especially core 5. One you are done fixing the bug or adding your feature, make a merge request
functionality. For backwards compatibility Purr Data ships many legacy in the Gitlab UI so we can merge the fix for the next release.
libraries which unfortunately duplicate the same functionality. This makes
it harder to learn how to use Pd, and makes it burdensome to read patches A few guidelines:
and keep track of all the disparate implementations. * _No prototypes, please_. Purr Data's biggest strength is that users can
6. Send us a merge request and we'll test it. If it's well-documented and turn an idea into working code very quickly. But a prototyping language that
there aren't any bugs we'll add it to the software. is itself a prototype isn't very useful. That means Purr Data's core code
and libraries must be stable, consistent, well-documented, and easy to use.
* Develop incrementally. Small, solid improvements to the software are
preferable to large, disruptive ones.
* Make sure you aren't duplicating existing functionality, especially core
functionality. For backwards compatibility Purr Data ships many legacy
libraries which unfortunately duplicate the same functionality. This makes
it harder to learn how to use Pd, and makes it burdensome to read patches
and keep track of all the disparate implementations.
Here are some of the current tasks: Here are some of the current tasks:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment