Skip to content

Commit f4effbe

Browse files
dylanwhhellcp
andauthored
Integrate documentation overhaul (#51)
* Update contributors documentation * Update README.md Co-authored-by: Stasiek Michalski <hellcp@opensuse.org>
1 parent 8326648 commit f4effbe

File tree

7 files changed

+429
-399
lines changed

7 files changed

+429
-399
lines changed

.github/pull_request_template.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#### Details
2+
<!-- Explain what you did -->
3+
This PR fixes/adds a feature...
4+
5+
#### Additional info
6+
* [bmo#](https://bugzilla.mozilla.org/show_bug.cgi?id=)
7+
8+
#### Test Plan
9+
<!-- How did you verify the fix/feature in steps -->
10+
1. Open the show_bug view
11+
2. Edit the bug
12+
3. ...

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
![Banner](images/banner.png)
2+
# Bugzilla Harmony [![CircleCI Status](https://circleci.com/gh/bugzilla/harmony/tree/master.svg?style=shield)](https://circleci.com/gh/bugzilla/harmony/tree/master) [![New Issue on Bugzilla](https://img.shields.io/badge/new%20issue-on%20bugzilla-blueviolet?style=flat)](https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&format=__default__ "Report a new issue") [![Chat on Matrix](https://img.shields.io/badge/chat-on%20matrix-blue?style=flat&icon=matrix)](https://matrix.to/#/#bugzilla:mozilla.org)
3+
4+
**Web based general purpose defect tracking software that helps to drive
5+
software development.**
6+
7+
Stable and reliable, tested by thousands of largest open source
8+
organizations all around the world. It can be installed on Linux, mac OS,
9+
other flavors of Unix and Windows.
10+
11+
For the full list of features, you can check the
12+
[Bugzilla website](https://www.bugzilla.org/features/).
13+
14+
## Demo
15+
16+
You can try Bugzilla on the
17+
[test instance](https://bugzilla-dev.allizom.org)
18+
19+
![Screengrab](images/bzgif.gif)
20+
21+
## Development
22+
23+
If you want to contribute to Bugzilla, you can fork this repo and get a
24+
local copy of it running in a few minutes using Docker with the help of
25+
the [guide](docker/development.md).
26+
27+
Make yourself familiar with [CONTRIBUTING.md](CONTRIBUTING.md), so your
28+
PR gets quickly and swiftly through the review process.
29+
30+
## Installation
31+
32+
You can use the provided docker container to set up Bugzilla, which is
33+
documented in [docker/README.md](docker/README.md).
34+
35+
For other ways of installing Bugzilla, refer to our
36+
[installation documentation](https://bugzilla.readthedocs.io/en/latest/installing/index.html).
37+
38+
## Documentation
39+
40+
* [Main documentation](https://bugzilla.readthedocs.io)
41+
* [Developer resources](https://www.bugzilla.org/developers/)
42+
43+
## Reporting Bugs
44+
45+
You can report bugs on the
46+
[Mozilla Bugzilla](https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&format=__default__)
47+
48+
## Community
49+
50+
* [#bugzilla on Freenode](irc://irc.mozilla.org/bugzilla)
51+
* [Matrix](https://matrix.to/#/#bugzilla:mozilla.org)
52+
* [Twitter](https://twitter.com/bugzilla)
53+
* [Development Forum](https://www.mozilla.org/en-US/about/forums/#dev-apps-bugzilla)
54+
* [Support Forum](https://www.mozilla.org/en-US/about/forums/#support-bugzilla)
55+
* [Code of Conduct](CODE_OF_CONDUCT.md)
56+
* [Website](https://www.bugzilla.org)

0 commit comments

Comments
 (0)