|
| 1 | +# Contributing to Eclipse Theia C/C++ Extensions |
| 2 | + |
| 3 | +This repository is the home to Theia's C/C++ extensions. |
| 4 | + |
| 5 | +See Theia's main repository to get more information about the IDE: |
| 6 | +https://github.com/eclipse/theia |
| 7 | + |
| 8 | +## How Can I Contribute? |
| 9 | + |
| 10 | +In the following some of the typical ways of contribution are described. |
| 11 | + |
| 12 | +### Asking Questions |
| 13 | + |
| 14 | +It's totally fine to ask questions by opening an issue in the Theia GitHub |
| 15 | +repository. We will close it once it's answered and tag it with the 'question' |
| 16 | +label. Please check if the question has been asked before there or on [Stack |
| 17 | +Overflow](https://stackoverflow.com). |
| 18 | + |
| 19 | +### Reporting Bugs |
| 20 | + |
| 21 | +If you have found a bug, you should first check if it has already been filed |
| 22 | +and maybe even fixed. If you find an existing unresolved issue, please add your |
| 23 | +case. If you could not find an existing bug report, please file a new one. In |
| 24 | +any case, please add all information you can share and that will help to |
| 25 | +reproduce and solve the problem. |
| 26 | + |
| 27 | +### Reporting Feature Requests |
| 28 | + |
| 29 | +You may want to see a feature or have an idea. You can file a request and we |
| 30 | +can discuss it. If such a feature request already exists, please add a comment |
| 31 | +or some other form of feedback to indicate you are interested too. Also in this |
| 32 | +case any concrete use case scenario is appreciated to understand the motivation |
| 33 | +behind it. |
| 34 | + |
| 35 | +### Pull Requests |
| 36 | + |
| 37 | +Before you get started investing significant time in something you want to get |
| 38 | +merged and maintained as part of Theia, you should talk with the team through |
| 39 | +an issue. Simply choose the issue you would want to work on, and tell everyone |
| 40 | +that you are willing to do so and how you would approach it. The team will be |
| 41 | +happy to guide you and give feedback. |
| 42 | + |
| 43 | +## Coding Guidelines |
| 44 | + |
| 45 | +We follow the coding guidelines described |
| 46 | +[here](https://github.com/eclipse/theia/wiki/Coding-Guidelines). |
| 47 | + |
| 48 | +## Eclipse Contributor Agreement |
| 49 | + |
| 50 | +Before your contribution can be accepted by the project team contributors must |
| 51 | +electronically sign the Eclipse Contributor Agreement (ECA). |
| 52 | + |
| 53 | +* http://www.eclipse.org/legal/ECA.php |
| 54 | + |
| 55 | +Commits that are provided by non-committers must have a Signed-off-by field in |
| 56 | +the footer indicating that the author is aware of the terms by which the |
| 57 | +contribution has been provided to the project. The non-committer must |
| 58 | +additionally have an Eclipse Foundation account and must have a signed Eclipse |
| 59 | +Contributor Agreement (ECA) on file. |
| 60 | + |
| 61 | +For more information, please see the Eclipse Committer Handbook: |
| 62 | +https://www.eclipse.org/projects/handbook/#resources-commit |
| 63 | + |
| 64 | +## Sign your work |
| 65 | + |
| 66 | +The sign-off is a simple line at the end of the explanation for the patch. Your |
| 67 | +signature certifies that you wrote the patch or otherwise have the right to |
| 68 | +pass it on as an open-source patch. |
| 69 | + |
| 70 | + Signed-off-by: Joe Smith <[email protected]> |
| 71 | + |
| 72 | +Use your real name (sorry, no pseudonyms or anonymous contributions.) |
| 73 | + |
| 74 | +If you set your `user.name` and `user.email` git configs, you can sign your |
| 75 | +commit automatically with `git commit -s`. |
0 commit comments