Difference between revisions of "Guideline: How to Contribute Code"
From GhostBSD Wiki
(→Introduction) |
|||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{welcome}} | {{welcome}} | ||
{{Navbar Development Contributor Page}} | {{Navbar Development Contributor Page}} | ||
| − | {{ | + | {{restricted}} |
| − | + | ||
==Introduction== | ==Introduction== | ||
| − | On this page we would like to give you some rules for developers, how to contribute code and how things need should be done. The following guidline is derived from a statement of Eric Turgeon at | + | On this page we would like to give you some rules for developers, how to contribute code and how things need should be done. The following guidline is derived from a statement of Eric Turgeon at 13.06.20 as founder and leader of this project with remarks from Vic Thacker at 30.05.20 on Telegram. |
| − | + | ||
| − | + | ||
==Guidline== | ==Guidline== | ||
| Line 13: | Line 10: | ||
In the meantime, for those that GhostBSD Github members. | In the meantime, for those that GhostBSD Github members. | ||
| − | # The only official supported desktop is MATE. The other DE's are community releases. That might change in the future, but for now, the main focus is MATE. Nevertheless the same rules apply to the ports and changes to ghostbsd-build and all the other tools. | + | # The only official supported desktop is [[MATE]]. The other DE's are community releases. That might change in the future, but for now, the main focus is [[MATE]]. Nevertheless the same rules apply to the ports and changes to [https://github.com/ghostbsd/ghostbsd-build ghostbsd-build] and all the other tools. |
| − | # For ports, make sure new or update port does not change or override a file from other ports, including config files. All files that ports installed need to be tracked except config files. | + | # For ports, make sure new or update port does not change or override a file from other ports, including config files. With other words: ports have only to care about themselves. All files that ports installed need to be tracked, except config files. |
| − | # Follow the FreeBSD | + | # Follow the [https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/ The FreeBSD porters Handbook] for test or the guideline to make ports. A useful tool is [https://www.freebsd.org/cgi/man.cgi?query=portlint&apropos=0&sektion=0&manpath=FreeBSD+12.1-RELEASE+and+Ports&arch=default&format=html portlint] to verify the port is done right. |
| − | # When it comes to the GhostBSD tools, including ghostbsd-build, work on sorted tickets. If there is no ticket, no code gets in unless it is new port or port updates. | + | # When it comes to the GhostBSD tools, including [https://github.com/ghostbsd/ghostbsd-build ghostbsd-build], work on sorted tickets. If there is no ticket, no code gets in unless it is new port or port updates. |
# Please do not create a ticket with questions. It will close immediately with a reply message to join GHostBSD forums or Telegram for questions. | # Please do not create a ticket with questions. It will close immediately with a reply message to join GHostBSD forums or Telegram for questions. | ||
# If you have an idea, share it with everyone on Telegram. If the idea is good, a ticket will be done. | # If you have an idea, share it with everyone on Telegram. If the idea is good, a ticket will be done. | ||
| − | # If you work on a non-official GhostBSD, like XFCE, let everyone know on Telegram, what you are working on, to make sure no one oversteps on other's works. | + | # If you work on a non-official GhostBSD, like [[XFCE]], let everyone know on Telegram, what you are working on, to make sure no one oversteps on other's works. |
| − | # Don't start something that will affect any GhostBSD | + | # Don't start something that will affect any GhostBSD tool and / or GhostBSD itself without a sorted ticket. The main reason is unplanned changes can affect other's work and affect the main project. |
| − | # The main point is to communicate | + | # The main point is, to communicate with all people who are working on GhostBSD. Transparency is important to avoid frustrations. That want to contribute may become a concern to ensure effective teamwork. |
| + | # If you work with a team spirit in mind and have proved your self you will get a member of the developer team. | ||
| + | # Each change needs to be tested by the developer, and peer reviewed. It is a standard software development practice. We are looking at having more discipline in our practice as the number of programmers increase. It will improve and help ensure code quality, better documentation, and communication within the group. | ||
For anyone who is not happy with this can start his/her own project. | For anyone who is not happy with this can start his/her own project. | ||
Latest revision as of 12:54, 19 June 2020
Welcome to  Guideline: How to Contribute Code.
|
| Development Contributor Page | ||
|---|---|---|
| Porters Guideline | Guideline: How to Contribute Code | GhostBSD Builds |
Back to  Contribution
| ||
| Restricted! Please do not change this page without permission from the author of this page! |
Introduction[edit]
On this page we would like to give you some rules for developers, how to contribute code and how things need should be done. The following guidline is derived from a statement of Eric Turgeon at 13.06.20 as founder and leader of this project with remarks from Vic Thacker at 30.05.20 on Telegram.
Guidline[edit]
In the meantime, for those that GhostBSD Github members.
- The only official supported desktop is MATE. The other DE's are community releases. That might change in the future, but for now, the main focus is MATE. Nevertheless the same rules apply to the ports and changes to ghostbsd-build and all the other tools.
- For ports, make sure new or update port does not change or override a file from other ports, including config files. With other words: ports have only to care about themselves. All files that ports installed need to be tracked, except config files.
- Follow the The FreeBSD porters Handbook for test or the guideline to make ports. A useful tool is portlint to verify the port is done right.
- When it comes to the GhostBSD tools, including ghostbsd-build, work on sorted tickets. If there is no ticket, no code gets in unless it is new port or port updates.
- Please do not create a ticket with questions. It will close immediately with a reply message to join GHostBSD forums or Telegram for questions.
- If you have an idea, share it with everyone on Telegram. If the idea is good, a ticket will be done.
- If you work on a non-official GhostBSD, like XFCE, let everyone know on Telegram, what you are working on, to make sure no one oversteps on other's works.
- Don't start something that will affect any GhostBSD tool and / or GhostBSD itself without a sorted ticket. The main reason is unplanned changes can affect other's work and affect the main project.
- The main point is, to communicate with all people who are working on GhostBSD. Transparency is important to avoid frustrations. That want to contribute may become a concern to ensure effective teamwork.
- If you work with a team spirit in mind and have proved your self you will get a member of the developer team.
- Each change needs to be tested by the developer, and peer reviewed. It is a standard software development practice. We are looking at having more discipline in our practice as the number of programmers increase. It will improve and help ensure code quality, better documentation, and communication within the group.
For anyone who is not happy with this can start his/her own project.
