Contributing to ChurchCRM
An introduction to contributing to the ChurchCRM project.
The project welcomes, and depends on, contributions from developers and users in the open source community. Contributions can be made in a number of ways. A few examples are:
- Code patches via pull requests
- Documentation improvements
- Bug reports and patch reviews
- Read this whole page "top to bottom."
- Introduce yourself in the developer chat at https://gitter.im/ChurchCRM/CRM
- Take a look at the Open Issues page.
We've made it easy for beginners with the Good First Bug Label.
These are issues that should be relatively easy to fix.
- Have fun!
Testing A Branch
As long as there is software, there is a need for software testers. We're no different. Even though we have many automated tests, there's still a very real need for actual human beings to test new features, bug fixes, and other aspects of the software.
Setting Up A Testing Machine
There are two system requirements for a testing machine:
- Oracle Virtual Box
- Oracle VirtualBox allows you to run virtual machines on your system for free.
- Vagrant is a tool that automagically provisions a virtual machine in Oracle VritualBox featuring all of the prerequisites, settings, files, and other artifacts required for running an instance of ChurchCRM. Since ChurchCRM is a web application, the "vagrant image" also includes a fully functional LAMP stack.
- Check out the branch you're going to test. You can use the GitHub Desktop Client, manually download the source from the GitHub Page, or click one of the following links:
- If you downloaded a Zip file, please extract that ZIP to a directory
- From a command line, navigate to the directory containing the files
- Run the command "vagrant up"
- Wait for the prompt that says ChurchCRM is now Hosted
- Open a browser to (http://192.168.33.10)
- Test the features in question
- Report any issues
- Clean up. From the same command line, run "vagrant destroy" to remove all traces of the code you were just testing.
Reporting an issue?
When reporting an issue, please include as much detail as you can. Let us know your platform and ChurchCRM version. If the problem is visual (for example a theme or design issue) please add a screenshot; and if you get an error please include the the full error and traceback.
Installing for development
Running the tests
[Need test so that the build systems can run] (https://github.com/ChurchCRM/CRM/issues/13)
Submitting Pull Requests
Once you are happy with your changes or you are ready for some feedback, push it to your fork and send a pull request. For all change requests, documentation and unit tests will be required for acceptance.