|
1
|
## Contributing to pfSense
|
|
2
|
|
|
3
|
The pfSense project welcomes contributions, big or small. Members of the pfSense community frequently contribute bug fixes, enhancements, and documentation changes to improve the functionality and usability of the software.
|
|
4
|
|
|
5
|
All of the pfSense project source code is on GitHub. We recommend potential contributors familiarize themselves with [the pfSense project git repositories](https://github.com/pfsense) and [GitHub in general](https://help.github.com).
|
|
6
|
|
|
7
|
If you want to contribute but do not have a specific topic in mind, review the [list of open bug reports and other issues that are in need of attention](https://redmine.pfsense.org/projects/pfsense/issues).
|
|
8
|
|
|
9
|
Contact [coreteam@pfsense.org](mailto:coreteam@pfsense.org "Mail to coreteam@pfsense.org") with any additional questions or concerns.
|
|
10
|
|
|
11
|
Before submitting changes, please take a few moments to review our submission guidelines below.
|
|
12
|
|
|
13
|
### **Security Submissions**
|
|
14
|
|
|
15
|
We prefer [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure) for security concerns.
|
|
16
|
|
|
17
|
If you have discovered a security issue, **do not** create a pull request or open a public bug report. Instead, disclose the details of the potential problem to us privately.
|
|
18
|
|
|
19
|
See https://www.pfsense.org/security/ for information on how to submit security issues, including information on our PGP key for encrypting messages.
|
|
20
|
|
|
21
|
### **Bug Reports and Feature Requests**
|
|
22
|
|
|
23
|
Bug reports and feature requests are tracked at https://redmine.pfsense.org
|
|
24
|
|
|
25
|
Please search for existing issues before opening a new report. Before opening a new issue, read the [guidelines for submitting bug reports](https://doc.pfsense.org/index.php/Bug_reporting).
|
|
26
|
|
|
27
|
If you are submitting a pull request, locate or create a corresponding Redmine entry first and provide a link to the issue in the pull request.
|
|
28
|
|
|
29
|
### **Submitting Changes**
|
|
30
|
|
|
31
|
The easiest and best way to contribute code changes to the project is through pull requests on GitHub.
|
|
32
|
|
|
33
|
For an outline of the process and guidelines to follow, see [Submitting a Pull Request via GitHub](https://doc.pfsense.org/index.php/Submitting_a_Pull_Request_via_Github)
|
|
34
|
|
|
35
|
Contributed code must conform to the [pfSense project Developer Style Guide](https://doc.pfsense.org/index.php/Developer_Style_Guide).
|
|
36
|
|