Beginner's Guide - TypeCobolTeam/TypeCobol GitHub Wiki
The TypeCobol project is owned by the organization TypeCobol Team. Members of the Taskforce can freely commit, push and merge, but only Owners can directly act on the organization settings, on teams (ie. add or remove members) or on repositories (ie. create and delete repositories). Everybody can create issues, but people who do not belong to the TypeCobol Team should only create issues with the proposal label. People who do not belong cannot be assigned any issue, either.
Github pretty much takes you by the hand so you won't feel too lost during your first few days of use.
In addition to Github's bootcamp (you get it on your profile page), here is an additional useful link.
- You shouldn't need to Create a repository, so you can forget about this section.
- Feel free to Open an issue when you deem it necessary. Tag your issue whith the existing labels as much as possible. An issue should ne closed only if the task is done, meaning :
- There's a commit that fixes the issue
- Unit tests are written and committed, so the issue won't happen again (see below)
Know that you can reference other github users in an issue with
@<pseudonym>
. The referenced user will be notified, allowing you to "poke" him/her and get his/her attention on a specific subject.
- Git branch creation is easy and lightweight, so Create a branch for each focused but ongoing development (more than a few commits or more than a day worth of work).
-
Commit early, Commit often. Make your commits as atomic as possible. Branching is your friend for bigger scopes features/bugs. If your commits are related to an already created issue (and they should be!), mention the issue in your commit comment, so your commit and the issue are intervined together. This can be done using the following syntax
issue #<issue number>: <your comment>
, and makes backtracking a lot easier. - Github users foreign to the TypeCobolTeam organization and interested by contributing to the TypeCobol project have to use Pull Requests (see below).
- On the other hand, TypeCobol Team members can commit and push their work directly on the repository.
- If you wanna know about everything happening on a repository, watch this repository.
- If you just wanna know about what directly concerns you, star this repository.
Github users foreign to the TypeCobolTeam organization and interested by contributing to the TypeCobol project have to use pull requests :
- Create an issue describing what they want to do, labelling this issue with the proposal label. Discussion ensue. If accepted by the TypeCobol Team, the issue gets the enhancement label.
- Fork the TypeCobol Repository
- Hack the code as desired.
- Open a Pull Request when the job is done. The pull request will be analyzed by TypeCobol Team members. When the Pull Request is good, a TypeCobol Team member will Merge Pull Request.
For a feature to be finished or a bug to be fixed, sufficient unit tests must be written. No issue shall be closed if the unit tests are not written.
Concerning writing of COBOL syntax specific tests, take a look at this page.
To participate to, or simply to have an idea of the COBOL syntax implementation progression, take a look at this page.