mirror of
https://github.com/vyos/vyos-build.git
synced 2025-10-01 20:28:40 +02:00
T5001: Replace links to the phabricator site
Replace links to the phabricator site from https://phabricator.vyos.net to https://vyos.dev (cherry picked from commit 82f35fd474400429cc73cc93386f2a21afd9aaf8)
This commit is contained in:
parent
3da60940f8
commit
f810d032e1
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -19,7 +19,7 @@ the box, please use [x]
|
||||
|
||||
## Related Task(s)
|
||||
<!-- All submitted PRs must be linked to a Task on Phabricator. -->
|
||||
* https://phabricator.vyos.net/Txxxx
|
||||
* https://vyos.dev/Txxxx
|
||||
|
||||
## Component(s) name
|
||||
<!-- A rather incomplete list of components: ethernet, wireguard, bgp, mpls, ldp, l2tp, dhcp ... -->
|
||||
|
||||
@ -8,6 +8,81 @@ review this contribution guideline.
|
||||
|
||||
The following paragraphs are an excerpt from our Documentation.
|
||||
|
||||
## Submit a Patch
|
||||
|
||||
Patches are always more than welcome. To have a clean and easy to maintain
|
||||
repository we have some guidelines when working with Git. A clean repository
|
||||
eases the automatic generation of a changelog file.
|
||||
|
||||
A good approach for writing commit messages is actually to have a look at the
|
||||
file(s) history by invoking git log path/to/file.txt.
|
||||
|
||||
### Prepare patch/commit
|
||||
|
||||
In a big system, such as VyOS, that is comprised of multiple components, it’s
|
||||
impossible to keep track of all the changes and bugs/feature requests in one’s
|
||||
head. We use a bugtracker known as Phabricator for it (“issue tracker” would
|
||||
be a better term, but this one stuck).
|
||||
|
||||
The information is used in three ways:
|
||||
|
||||
* Keep track of the progress (what we have already done in this branch and
|
||||
what we still need to do).
|
||||
* Prepare automatic release notes for upcoming releases
|
||||
* Help future maintainers of VyOS (it could be you!) to find out why certain
|
||||
things have been changed in the codebase or why certain features have been
|
||||
added
|
||||
|
||||
To make this approach work, every change must be associated with a task number
|
||||
(prefixed with **T**) and a component. If there is no bug report/feature
|
||||
request for the changes you are going to make, you have to create a Phabricator
|
||||
task first. Once there is an entry in Phabricator, you should reference its id
|
||||
in your commit message, as shown below:
|
||||
|
||||
* `ddclient: T1030: auto create runtime directories`
|
||||
* `Jenkins: add current Git commit ID to build description`
|
||||
|
||||
If there is no [Phabricator](https://vyos.dev) reference in the
|
||||
commits of your pull request, we have to ask you to amend the commit message.
|
||||
Otherwise we will have to reject it.
|
||||
|
||||
## Writing good commit messages
|
||||
|
||||
The format should be and is inspired by this very good and detailed
|
||||
[Git documentation](https://git-scm.com/book/ch5-2.html), it is also worth
|
||||
reading https://chris.beams.io/posts/git-commit/.
|
||||
|
||||
This is nothing VyOS specific - it is more a general topic for distributed
|
||||
development environments.
|
||||
|
||||
* A single, short, summary of the commit (recommended 50 characters or less,
|
||||
not exceeding 80 characters) containing a prefix of the changed component
|
||||
and the corresponding Phabricator reference e.g. `snmp: T1111:` or
|
||||
`ethernet: T2222:` - multiple components could be concatenated as in `snmp:
|
||||
ethernet: T3333`
|
||||
* In some contexts, the first line is treated as the subject of an email and
|
||||
the rest of the text as the body. The blank line separating the summary from
|
||||
the body is critical (unless you omit the body entirely); tools like rebase
|
||||
can get confused if you run the two together.
|
||||
* Followed by a message which describes all the details like:
|
||||
* What/why/how something has been changed, makes everyone’s life easier when
|
||||
working with `git bisect`
|
||||
* All text of the commit message should be wrapped at 72 characters if
|
||||
possible which makes reading commit logs easier with git log on a standard
|
||||
terminal (which happens to be 80x25)
|
||||
* If applicable a reference to a previous commit should be made linking those
|
||||
commits nicely when browsing the history: `After commit abcd12ef ("snmp:
|
||||
this is a headline") a Python import statement is missing, throwing the
|
||||
following exception: ABCDEF`
|
||||
* Always use the `-x` option to the `git cherry-pick` command when back or
|
||||
forward porting an individual commit. This automatically appends the line:
|
||||
`(cherry picked from commit <ID>)` to the original authors commit message
|
||||
making it easier when bisecting problems.
|
||||
* Every change set must be consistent (self containing)! Do not fix multiple
|
||||
bugs in a single commit. If you already worked on multiple fixes in the same
|
||||
file use git add –patch to only add the parts related to the one issue into
|
||||
your upcoming commit.
|
||||
|
||||
## Bug Report/Issue
|
||||
Issues or bugs are found in any software project. VyOS is not an exception.
|
||||
|
||||
@ -51,7 +126,7 @@ also contain information that is helpful for the development team.
|
||||
### Reporting
|
||||
|
||||
In order to open up a bug-report/feature request you need to create yourself
|
||||
an account on [Phabricator](https://phabricator.vyos.net). On the left
|
||||
an account on [Phabricator](https://vyos.dev). On the left
|
||||
side of the specific project (VyOS 1.2 or VyOS 1.3) you will find quick-links
|
||||
for opening a bug-report/feature request.
|
||||
|
||||
@ -66,7 +141,7 @@ for opening a bug-report/feature request.
|
||||
|
||||
You have an idea of how to make VyOS better or you are in need of a specific
|
||||
feature which all users of VyOS would benefit from? To send a feature request
|
||||
please search [Phabricator](https://phabricator.vyos.net) if there is already a
|
||||
please search [Phabricator](https://vyos.dev) if there is already a
|
||||
request pending. You can enhance it or if you don't find one, create a new one
|
||||
by use the quick link in the left side under the specific project.
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
Welcome to VyOS!
|
||||
|
||||
Check out project news at https://blog.vyos.io
|
||||
and feel free to report bugs at https://phabricator.vyos.net
|
||||
and feel free to report bugs at https://vyos.dev
|
||||
|
||||
You can change this banner using "set system login banner post-login" command.
|
||||
|
||||
|
||||
@ -112,7 +112,7 @@ VERSION_CODENAME=buster
|
||||
ID=vyos
|
||||
HOME_URL="https://vyos.io"
|
||||
SUPPORT_URL="https://support.vyos.io"
|
||||
BUG_REPORT_URL="https://phabricator.vyos.net"
|
||||
BUG_REPORT_URL="https://vyos.dev"
|
||||
"""
|
||||
|
||||
os.makedirs(os.path.join(defaults.CHROOT_INCLUDES_DIR, 'usr/share/vyos'), exist_ok=True)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user