Difference between revisions of "Guideline: How to Contribute Code"
From GhostBSD Wiki
(→Introduction) |
|||
| Line 5: | Line 5: | ||
==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. | + | 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 16:39] on telegram al leader of this project. |
| + | |||
| + | The more people work on a project the more necessary is it, to follow some simple rules, to ensure a save workflow to build GhostBSD releases. For a project it is important to get a clear structure, open communication, and transparency. | ||
==Guidline== | ==Guidline== | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
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. | |
| − | + | # 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. All files that ports installed need to be tracked except config files. Follow the FreeBSD ports Handbook for test for the guideline to make ports. A useful tool is portlint to verify the port is done right. | + | # Follow the FreeBSD ports Handbook for test for 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. | |
| − | 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 | + | # 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 tools 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 whit all people who are working on GhostBSD. Transparency is important to avoid frustrations. | ||
| − | |||
| − | |||
| − | + | For anyone who is not happy with this can start his/her own project. | |
Revision as of 08:56, 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
| ||
| This page is in maintenance! Please do not change this page without to contact the author or use Discussion! |
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 [13.06.20 16:39] on telegram al leader of this project.
The more people work on a project the more necessary is it, to follow some simple rules, to ensure a save workflow to build GhostBSD releases. For a project it is important to get a clear structure, open communication, and transparency.
Guidline
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. All files that ports installed need to be tracked except config files.
- Follow the FreeBSD ports Handbook for test for 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 tools 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 whit all people who are working on GhostBSD. Transparency is important to avoid frustrations.
For anyone who is not happy with this can start his/her own project.
