Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
P
purr-data
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Wynn
purr-data
Commits
1c8dae7d
Commit
1c8dae7d
authored
7 years ago
by
Jonathan Wilkes
Browse files
Options
Downloads
Patches
Plain Diff
improve contributor guide to accommodate newcomers with easy bugfixes
parent
2aa4623e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+24
-16
24 additions, 16 deletions
README.md
with
24 additions
and
16 deletions
README.md
+
24
−
16
View file @
1c8dae7d
...
...
@@ -259,22 +259,30 @@ Contributing is easy:
1.
Join the development list:
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
example, there are _lots_ of externals and even core features that are
poorly documented.
3.
_No prototypes, please_. Purr Data's biggest strength is that users can
turn an idea into working code very quickly. But a prototyping language that
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.
4.
Develop incrementally. Small, solid improvements to the software are
preferable to large, disruptive ones.
5.
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.
6.
Send us a merge request and we'll test it. If it's well-documented and
there aren't any bugs we'll add it to the software.
2.
Fork Purr Data using the gitlab UI and then try to build it from source
for your own platform using the
[
Build Guide
](
#build-guide
)
above.
If you run into problems ask on the development list for help.
3.
Once you have successfully built Purr Data, install it and make sure it
runs correctly.
4.
Start making changes to the code with brief, clear commit messages. If you
want some practice you can try fixing one of the bugs on the issue tracker
labeled
[
"good-first-bug"
](
https://git.purrdata.net/jwilkes/purr-data/issues?label_name%5B%5D=good-first-bug
)
5.
One you are done fixing the bug or adding your feature, make a merge request
in the Gitlab UI so we can merge the fix for the next release.
A few guidelines:
*
_No prototypes, please_. Purr Data's biggest strength is that users can
turn an idea into working code very quickly. But a prototyping language that
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:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment