CopperSpice Overview
How to Contribute

As the maintainers of the CopperSpice project we welcome contributions from anyone in the open source community. Changes to the source code should be made in the form of a github pull request. We encourage developers to report issues, ideas for documentation improvements, or other suggestions on github or the CopperSpice support forum.

How to Make a Pull Request

These following directions will detail how to make a pull request for the CopperSpice libraries. This information applies for any of our other libraries in addition to the KitchenSink, DoxyPress, Diamond, and Designer applications.

  • We ask that submitted source code be readable, formatted, and tested. Refer to our Source Code Style for code formatting guidelines.
  • If you are unable to test on Unix, Windows, and Mac OS X please let us know with your submission.
Fork the github project
Go to the github repo https://github.com/copperspice/copperspice and click on the "fork" button located near the top right of the window
Retrieve the URL
In your github account there will be a new repository with the name "copperspice". Press the green button labeled "code" to retrieve a url. This is a link which points to your copy of the copperspice repository in your github account.
Clone the new repo to your local computer
On your computer open a git command prompt and run "git clone <url>"
Create a branch where you can commit your changes
From your git command prompt, run "git checkout -b <branch_name>"
Make your source code changes
Edit the source code
Commit changes in your local repo
From your git command prompt run "git add <src_file_name>" and then "git commit"
Push your branch to your fork
From your git command prompt run "git push origin <branch_name>"
Create a pull request on github
From your github account, from your fork of copperspice, create a PR (pull request)

Reporting an Issue

  • When reporting a potential issue or problem, file an "Issue" on the corresponding github repository. As a alternative you can post post a message on our CopperSpice forum.
  • When posting please provide or attach a small code sample to demonstrate how to reproduce your problem. On the ticket indicate your Operating System and Version, and the version of CopperSpice.

   Github
   CS Forum

Suggestions

Suggestions for new or expanded functionality will be reviewed and scheduled by priority. If more developers request the same item this will influence what is added to CopperSpice. We can not guarantee when something will be added to the CopperSpice libraries.

Companies which need a new feature or enhancement with a quicker response time should contact the development team by email for additional information and consulting fees.

Licensing

  • Your submission of source code grants us the right to use your work in CopperSpice according to the GNU LGPL2.1 license.
  • A CLA must be signed and submitted to contribute source code. Our CLA is as concise and short as possible. This is only required the first time you contribute.