-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1280 from jim-parry/dox/contributing
Add contributing reference to user guide
- Loading branch information
Showing
5 changed files
with
84 additions
and
1 deletion.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
########################### | ||
Contributing to CodeIgniter | ||
########################### | ||
|
||
CodeIgniter is a community driven project and accepts contributions of code | ||
and documentation from the community. These contributions are made in the form | ||
of Issues or `Pull Requests <https://help.github.com/articles/using-pull-requests/>`_ | ||
on the `CodeIgniter4 repository <https://github.com/bcit-ci/CodeIgniter4>`_ on GitHub. | ||
|
||
Issues are a quick way to point out a bug. If you find a bug or documentation | ||
error in CodeIgniter then please check a few things first: | ||
|
||
- There is not already an open Issue | ||
- The issue has already been fixed (check the develop branch, or look for | ||
closed Issues) | ||
- Is it something really obvious that you fix it yourself? | ||
|
||
Reporting issues is helpful but an even better approach is to send a Pull | ||
Request, which is done by "Forking" the main repository and committing to your | ||
own copy. This will require you to use the version control system called Git. | ||
|
||
Please see the `Contributing to CodeIgniter4 <https://github.com/bcit-ci/CodeIgniter4/tree/develop/contributing>`_ | ||
section of our code repository. | ||
|
||
|
||
******* | ||
Support | ||
******* | ||
|
||
Please note that GitHub is not for general support questions! If you are | ||
having trouble using a feature of CodeIgniter, ask for help on our | ||
`forums <http://forum.codeigniter.com/>`_ instead. | ||
|
||
If you are not sure whether you are using something correctly or if you | ||
have found a bug, again - please ask on the forums first. | ||
|
||
******** | ||
Security | ||
******** | ||
|
||
Did you find a security issue in CodeIgniter? | ||
|
||
Please *don't* disclose it publicly, but e-mail us at security@codeigniter.com, | ||
or report it via our page on `HackerOne <https://hackerone.com/codeigniter>`_. | ||
|
||
If you've found a critical vulnerability, we'd be happy to credit you in our | ||
`ChangeLog <https://bcit-ci.github.io/CodeIgniter4/changelog.html>`_. | ||
|
||
**************************** | ||
Tips for a Good Issue Report | ||
**************************** | ||
|
||
Use a descriptive subject line (eg parser library chokes on commas) rather than a vague one (eg. your code broke). | ||
|
||
Address a single issue in a report. | ||
|
||
Identify the CodeIgniter version (eg 4.0.1) and the component if you know it (eg. parser library) | ||
|
||
Explain what you expected to happen, and what did happen. | ||
Include error messages and stacktrace, if any. | ||
|
||
Include short code segments if they help to explain. | ||
Use a pastebin or dropbox facility to include longer segments of code or screenshots - do not include them in the issue report itself. | ||
This means setting a reasonable expiry for those, until the issue is resolved or closed. | ||
|
||
If you know how to fix the issue, you can do so in your own fork & branch, and submit a pull request. | ||
The issue report information above should be part of that. | ||
|
||
If your issue report can describe the steps to reproduce the problem, that is great. | ||
If you can include a unit test that reproduces the problem, that is even better, as it gives whoever is fixing | ||
it a clearer target! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,3 +9,4 @@ CodeIgniter 4 has been designed to be easy to extend or build upon. | |
|
||
core_classes | ||
events | ||
contributing |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters