Línea 1... |
Línea 1... |
1 |
# How to contribute to Teclib' CFPropertyList
|
1 |
# How to contribute to Moodle HQ's CFPropertyList
|
Línea 2... |
Línea 2... |
2 |
|
2 |
|
Línea 3... |
Línea -... |
3 |
Welcome to our ever-growing community :octocat:!
|
- |
|
4 |
|
- |
|
5 |
Teclib’ is an open source software editor that offers a vast range of fully integrated open source technology packages, to better respond to business needs.
|
3 |
Welcome to our ever-growing community :octocat:!
|
Línea 6... |
Línea 4... |
6 |
|
4 |
|
Línea 7... |
Línea 5... |
7 |
We are more than happy to accept external contributions to the project in the form of feedback, translations, bug reports, and even better, pull requests.
|
5 |
We are more than happy to accept external contributions to the project in the form of feedback, translations, bug reports, and even better, pull requests.
|
Línea 8... |
Línea 6... |
8 |
|
6 |
|
9 |
We present you here the guidelines to start contributing in any of the Teclib' projects.
|
7 |
We present you here the guidelines to start contributing to this project.
|
Línea 35... |
Línea 33... |
35 |
- 4.2.3.1 [Rules to Follow](#4.2.3.1)
|
33 |
- 4.2.3.1 [Rules to Follow](#4.2.3.1)
|
36 |
- 4.2.3.2 [Commit Format](#4.2.3.2)
|
34 |
- 4.2.3.2 [Commit Format](#4.2.3.2)
|
37 |
- 4.2.3.2.1 [Header: Writing a `type`](#4.2.3.2.1)
|
35 |
- 4.2.3.2.1 [Header: Writing a `type`](#4.2.3.2.1)
|
38 |
- 4.2.3.2.2 [Header: Writing the `(optional scope)`](#4.2.3.2.2 )
|
36 |
- 4.2.3.2.2 [Header: Writing the `(optional scope)`](#4.2.3.2.2 )
|
39 |
- 4.2.3.2.3 [Header: Writing a `description`](#4.2.3.2.3)
|
37 |
- 4.2.3.2.3 [Header: Writing a `description`](#4.2.3.2.3)
|
40 |
- 4.2.3.2.4 [Header Lenght](#4.2.3.2.4)
|
38 |
- 4.2.3.2.4 [Header Length](#4.2.3.2.4)
|
41 |
- 4.2.3.2.5 [Writing the `optional body`](#4.2.3.2.5)
|
39 |
- 4.2.3.2.5 [Writing the `optional body`](#4.2.3.2.5)
|
42 |
- 4.2.3.2.6 [Writing the `optional footer`](#4.2.3.2.6)
|
40 |
- 4.2.3.2.6 [Writing the `optional footer`](#4.2.3.2.6)
|
43 |
- 4.2.3.3 [Commit Examples](#4.2.3.3)
|
41 |
- 4.2.3.3 [Commit Examples](#4.2.3.3)
|
44 |
- 4.2.4 [Push your Changes](#4.2.4)
|
42 |
- 4.2.4 [Push your Changes](#4.2.4)
|
45 |
- 4.2.5 [Create a Pull Request](#4.2.5)
|
43 |
- 4.2.5 [Create a Pull Request](#4.2.5)
|
Línea 53... |
Línea 51... |
53 |
- 6 [Coding Rules](#6)
|
51 |
- 6 [Coding Rules](#6)
|
Línea 54... |
Línea 52... |
54 |
|
52 |
|
Línea 55... |
Línea 53... |
55 |
# <a name="1"></a> 1. See what's going on! [:top:](#top)
|
53 |
# <a name="1"></a> 1. See what's going on! [:top:](#top)
|
56 |
|
54 |
|
Línea 57... |
Línea 55... |
57 |
## <a name="1.1"></a> 1.1 Issue Dashboard
|
55 |
## <a name="1.1"></a> 1.1 Issue Dashboard
|
58 |
If you want to know all the issues we're dealing with right now, take a look at our [Issue Dashboard](https://github.com/TECLIB/CFPropertyList/issues) and look for areas in which you can help.
|
56 |
If you want to know all the issues we're dealing with right now, take a look at our [Issue Dashboard](https://github.com/moodlehq/CFPropertyList/issues) and look for areas in which you can help.
|
Línea 59... |
Línea 57... |
59 |
|
57 |
|
Línea 60... |
Línea 58... |
60 |
|
58 |
|
61 |
## <a name="1.2"></a> 1.2 Pull Request Dashboard
|
59 |
## <a name="1.2"></a> 1.2 Pull Request Dashboard
|
62 |
If you want to give us a hand solving issues then great, take a look at our [Pull Request Dashboard](https://github.com/TECLIB/CFPropertyList/pulls) and check for an open or closed PR. We don’t want to duplicate efforts.
|
- |
|
63 |
|
- |
|
64 |
# <a name="2"></a> 2. Assistance [:top:](#top)
|
- |
|
Línea 65... |
Línea 60... |
65 |
|
60 |
If you want to give us a hand solving issues then great, take a look at our [Pull Request Dashboard](https://github.com/moodlehq/CFPropertyList/pulls) and check for an open or closed PR. We don’t want to duplicate efforts.
|
Línea 66... |
Línea 61... |
66 |
## <a name="2.1"></a> 2.1 Contact us
|
61 |
|
67 |
You can contact us through any of our channels, check our [Contact section](http://www.teclib-edition.com/en/contact-us/)
|
62 |
# <a name="2"></a> 2. Assistance [:top:](#top)
|
Línea 68... |
Línea 63... |
68 |
|
63 |
|
69 |
## <a name="2.2"></a> 2.2 Customers Assistance
|
64 |
## <a name="2.1"></a> 2.1 Contact us
|
Línea 70... |
Línea 65... |
70 |
Use our official [support channel](https://support.teclib.com/).
|
65 |
You can contact us through any of our channels, check our [Contact section](https://moodledev.io/general/channels)
|
71 |
|
66 |
|
Línea 72... |
Línea 67... |
72 |
# <a name="3"></a> 3. Feature Requests [:top:](#top)
|
67 |
# <a name="3"></a> 3. Feature Requests [:top:](#top)
|
73 |
|
68 |
|
Línea 74... |
Línea 69... |
74 |
## <a name="3.1"></a> 3.1 Requirement for a Feature Request
|
69 |
## <a name="3.1"></a> 3.1 Requirement for a Feature Request
|
Línea 75... |
Línea 70... |
75 |
If you like to _implement_ a new feature please [submit an Issue](https://github.com/TECLIB/CFPropertyList/issues/new) with a proposal, so we can be sure it's relevant.
|
70 |
If you like to _implement_ a new feature please [submit an Issue](https://github.com/moodlehq/CFPropertyList/issues/new) with a proposal, so we can be sure it's relevant.
|
Línea 76... |
Línea 71... |
76 |
|
71 |
|
Línea 77... |
Línea 72... |
77 |
### <a name="3.1.1"></a> 3.1.1 Major Feature Request
|
72 |
### <a name="3.1.1"></a> 3.1.1 Major Feature Request
|
Línea 78... |
Línea 73... |
78 |
For a major new feature request, [open an Issue](https://github.com/TECLIB/CFPropertyList/issues/new) and outline your proposal so it can be discussed.
|
73 |
For a major new feature request, [open an Issue](https://github.com/moodlehq/CFPropertyList/issues/new) and outline your proposal so it can be discussed.
|
79 |
|
74 |
|
Línea 80... |
Línea 75... |
80 |
### <a name="3.1.2"></a> 3.1.2 Minor Feature Request
|
75 |
### <a name="3.1.2"></a> 3.1.2 Minor Feature Request
|
81 |
For a minor new feature request, you can craft it and directly [submit it as a Pull Request](https://github.com/TECLIB/CFPropertyList/pulls), we'll take care of it.
|
76 |
For a minor new feature request, you can craft it and directly [submit it as a Pull Request](https://github.com/moodlehq/CFPropertyList/pulls), we'll take care of it.
|
Línea 82... |
Línea 77... |
82 |
|
77 |
|
83 |
## <a name="3.2"></a> 3.2 Request a New Feature
|
78 |
## <a name="3.2"></a> 3.2 Request a New Feature
|
Línea 84... |
Línea 79... |
84 |
You can request a new feature by [submitting an Issue](https://github.com/TECLIB/CFPropertyList/issues/new)
|
79 |
You can request a new feature by [submitting an Issue](https://github.com/moodlehq/CFPropertyList/issues/new)
|
Línea 106... |
Línea 101... |
106 |
* :warning: **Observed Results:** A brief description of the problem.
|
101 |
* :warning: **Observed Results:** A brief description of the problem.
|
107 |
* :mag_right: **What steps will reproduce the issue?:** If suitable, including the steps required to reproduce the bug.
|
102 |
* :mag_right: **What steps will reproduce the issue?:** If suitable, including the steps required to reproduce the bug.
|
108 |
* :boom: **Expected Results:** What did you expect to happen?
|
103 |
* :boom: **Expected Results:** What did you expect to happen?
|
Línea 109... |
Línea 104... |
109 |
|
104 |
|
110 |
### <a name="4.1.5"></a> 4.1.5 Submit an Issue. :rocket:
|
105 |
### <a name="4.1.5"></a> 4.1.5 Submit an Issue. :rocket:
|
Línea 111... |
Línea 106... |
111 |
Having all data at hand, file the new issue by filling out our [Issue form](https://github.com/TECLIB/CFPropertyList/issues/new).
|
106 |
Having all data at hand, file the new issue by filling out our [Issue form](https://github.com/moodlehq/CFPropertyList/issues/new).
|
Línea 112... |
Línea 107... |
112 |
|
107 |
|
Línea 194... |
Línea 189... |
194 |
---
|
189 |
---
|
195 |
>**Example for `<description>`**:
|
190 |
>**Example for `<description>`**:
|
196 |
>feat(parser)::point_right:add ability to parse arrays:point_left:
|
191 |
>feat(parser)::point_right:add ability to parse arrays:point_left:
|
197 |
---
|
192 |
---
|
Línea 198... |
Línea 193... |
198 |
|
193 |
|
199 |
### <a name="4.2.3.2.4"></a> 4.2.3.2.4 Header Lenght
|
194 |
### <a name="4.2.3.2.4"></a> 4.2.3.2.4 Header Length
|
Línea 200... |
Línea 195... |
200 |
The **header** cannot be longer than 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
|
195 |
The **header** cannot be longer than 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
|
201 |
|
196 |
|
Línea 251... |
Línea 246... |
251 |
|
246 |
|
Línea 252... |
Línea 247... |
252 |
### <a name="4.2.5"></a> 4.2.5 Create a Pull Request
|
247 |
### <a name="4.2.5"></a> 4.2.5 Create a Pull Request
|
Línea 253... |
Línea 248... |
253 |
|
248 |
|
Línea 254... |
Línea 249... |
254 |
Pull requests or PR are **proposed changes** to a repository submitted by a user and accepted or rejected by a repository's collaborators.
|
249 |
Pull requests or PR are **proposed changes** to a repository submitted by a user and accepted or rejected by a repository's collaborators.
|
255 |
|
250 |
|
Línea 256... |
Línea 251... |
256 |
After all the work being pushed to the newly created branch, In GitHub, send a pull request to our [repository.](https://github.com/TECLIB/CFPropertyList/pulls)
|
251 |
After all the work being pushed to the newly created branch, In GitHub, send a pull request to our [repository.](https://github.com/moodlehq/CFPropertyList/pulls)
|
Línea 279... |
Línea 274... |
279 |
>:point_right:Added a Table of Content for the Contributing Guideline Document.:point_left:
|
274 |
>:point_right:Added a Table of Content for the Contributing Guideline Document.:point_left:
|
280 |
---
|
275 |
---
|
Línea 281... |
Línea 276... |
281 |
|
276 |
|
Línea 282... |
Línea 277... |
282 |
### <a name="4.2.5.2"></a> 4.2.5.2 Before Send a Pull Request
|
277 |
### <a name="4.2.5.2"></a> 4.2.5.2 Before Send a Pull Request
|
Línea 283... |
Línea 278... |
283 |
|
278 |
|
Línea 284... |
Línea 279... |
284 |
**1 - Pull Request Description:** Write a description about the changes, we provide a [template](https://github.com/TECLIB/CFPropertyList/community) for Pull Request descriptions. When you're creating a Pull Request it'll be shown automatically. Just fill it out and you're done.
|
279 |
**1 - Pull Request Description:** Write a description about the changes, we provide a [template](https://github.com/moodlehq/CFPropertyList/community) for Pull Request descriptions. When you're creating a Pull Request it'll be shown automatically. Just fill it out and you're done.
|
Línea 285... |
Línea 280... |
285 |
|
280 |
|
Línea 375... |
Línea 370... |
375 |
To ensure consistency throughout the source code, keep these rules in mind as you are working:
|
370 |
To ensure consistency throughout the source code, keep these rules in mind as you are working:
|
Línea 376... |
Línea 371... |
376 |
|
371 |
|
377 |
* All features or bug fixes must be tested by one or more specs (unit-tests).
|
372 |
* All features or bug fixes must be tested by one or more specs (unit-tests).
|
Línea 378... |
Línea -... |
378 |
* All methods must be documented.
|
- |
|
379 |
|
373 |
* All methods must be documented.
|
- |
|
374 |
|