CONTRIBUTING.md 2.91 KB
Newer Older
Adam Radocz's avatar
Adam Radocz committed
1 2 3 4 5
# Contributing to BOINC
:+1: First off, thank you for taking the time to contribute! It's people like you that make BOINC such a great tool. :+1:

## How Can I Contribute?

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
### Get Connected
Want to connect with contributors?
* Join us on [Slack](https://join.slack.com/t/boincworkspace/shared_invite/enQtNzA3MTQ4NDA0Njc4LTM4NTEyZTY1MWEwZjAyNTVmOTg3NDA2NjVjZDQzMWQ3NmFjYTc4MTNkNTEyNjRkOTQ4MWU5Nzk3NzRhNTg0NDI)
* Join the email lists:
  * [BOINC Overall](https://groups.google.com/forum/#!forum/boinc_admin)
  * [BOINC Projects](https://groups.google.com/a/ssl.berkeley.edu/forum/#!forum/boinc_projects)
  * [BOINC Development](https://groups.google.com/a/ssl.berkeley.edu/forum/#!forum/boinc_dev)
  * [BOINC Alpha Testing](https://groups.google.com/a/ssl.berkeley.edu/forum/#!forum/boinc_alpha)
* Join one of the community calls:
  * The BOINC Projects call occurs quarterly and is announced on the [BOINC Projects email list](https://groups.google.com/a/ssl.berkeley.edu/forum/#!forum/boinc_projects)
  * The BOINC Contributor call occurs every other week and is announced on the [BOINC Development email list](https://groups.google.com/a/ssl.berkeley.edu/forum/#!forum/boinc_dev)

### Promote Volunteer Computing
Want to help promote volunteer computing and work on ways to attract new users? Join the #communications channel on [Slack](https://join.slack.com/t/boincworkspace/shared_invite/enQtNzA3MTQ4NDA0Njc4LTM4NTEyZTY1MWEwZjAyNTVmOTg3NDA2NjVjZDQzMWQ3NmFjYTc4MTNkNTEyNjRkOTQ4MWU5Nzk3NzRhNTg0NDI)  

### Help Translate
Adam Radocz's avatar
Adam Radocz committed
22 23
See: https://boinc.berkeley.edu/trac/wiki/TranslateIntro

24 25
### Help Test
You can help new versions of the client.  
26 27
* Become an [Alpha Tester](https://boinc.berkeley.edu/trac/wiki/AlphaInstructions)
* Signup to be a [BOINC Android Tester](https://groups.google.com/forum/#!forum/boinc-android-testing)
28 29

### Report Bugs
Adam Radocz's avatar
Adam Radocz committed
30 31 32 33
Did you find a bug? Make a Bug report.
* Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/BOINC/boinc/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/BOINC/boinc/issues/new).

34 35
### Suggest Enhancements
Do you have a feature idea? Make a feature request.
Adam Radocz's avatar
Adam Radocz committed
36 37 38
* Ensure the feature was not already requested by searching on GitHub under [Issues](https://github.com/BOINC/boinc/issues).
* If you're unable to find an open issue addressing the idea, [open a new one](https://github.com/BOINC/boinc/issues/new).

39 40
### Contribute Code
Do you want to fix a bug or implement a new feature?  Read about how to [implement a code contribution](https://github.com/BOINC/boinc-policy/blob/master/Development_Documents/Development_Workflow.md#2-implementation).
Adam Radocz's avatar
Adam Radocz committed
41 42 43

## Styleguides

44 45 46
### BOINC Coding Styles
See https://boinc.berkeley.edu/trac/wiki/CodingStyle

Adam Radocz's avatar
Adam Radocz committed
47 48 49 50 51 52 53 54
### Git Commit Messages
* Use the present tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")


Thanks! :heart:

BOINC Team