picnoir
/
Systemd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Systemd/docs/CONTRIBUTING.md

45 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

docs: add a "front matter" snippet to our markdown pages It turns out Jekyll (the engine behind GitHub Pages) requires that pages include a "Front Matter" snippet of YAML at the top for proper rendering. Omitting it will still render the pages, but including it opens up new possibilities, such as using a {% for %} loop to generate index.md instead of requiring a separate script. I'm hoping this will also fix the issue with some of the pages (notably CODE_OF_CONDUCT.html) not being available under systemd.io Tested locally by rendering the website with Jekyll. Before this change, the *.md files were kept unchanged (so not sure how that even works?!), after this commit, proper *.html files were generated from it.
2019-01-02 23:16:34 +01:00
---
title: Contributing
docs: place all our markdown docs in rough categories
2019-12-11 10:49:28 +01:00
category: Contributing
docs: make it pretty Add custom Jekyll theme, logo, webfont and .gitignore FIXME: the markdown files have some H1 headers which need to be replaced with H2
2019-12-11 17:01:46 +01:00
layout: default
docs: add a "front matter" snippet to our markdown pages It turns out Jekyll (the engine behind GitHub Pages) requires that pages include a "Front Matter" snippet of YAML at the top for proper rendering. Omitting it will still render the pages, but including it opens up new possibilities, such as using a {% for %} loop to generate index.md instead of requiring a separate script. I'm hoping this will also fix the issue with some of the pages (notably CODE_OF_CONDUCT.html) not being available under systemd.io Tested locally by rendering the website with Jekyll. Before this change, the *.md files were kept unchanged (so not sure how that even works?!), after this commit, proper *.html files were generated from it.
2019-01-02 23:16:34 +01:00
---
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 12:02:03 +01:00
# Contributing
CONTRIBUTING: remove line wrapping GitHub displays this file poorly, because it preserves the newlines. Let's try how things look without any wrapping.
2016-05-31 19:27:41 +02:00
We welcome contributions from everyone. However, please follow the following guidelines when posting a GitHub Pull Request or filing a GitHub Issue on the systemd project:
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 12:02:03 +01:00
## Filing Issues
CONTRIBUTING: be clearer about versions and RFE process Fixes: #16550
2020-08-31 23:23:29 +02:00
* We use [GitHub Issues](https://github.com/systemd/systemd/issues) **exclusively** for tracking **bugs** and **feature** **requests** (RFEs) of systemd. If you are looking for help, please contact [systemd-devel mailing list](https://lists.freedesktop.org/mailman/listinfo/systemd-devel) instead.
docs: point contributors to list of most recent systemd releases Fixes: #16083
2020-06-09 09:42:12 +02:00
* We only track bugs in the **two** **most** **recently** **released** (non-rc) **versions** of systemd in the GitHub Issue tracker. If you are using an older version of systemd, please contact your distribution's bug tracker instead (see below). See [GitHub Release Page](https://github.com/systemd/systemd/releases) for the list of most recent releases.
CONTRIBUTING: be clearer about versions and RFE process Fixes: #16550
2020-08-31 23:23:29 +02:00
* When filing a feature request issue (RFE), please always check first if the newest upstream version of systemd already implements the feature, and whether there's already an issue filed for your feature by someone else.
CONTRIBUTING: remove line wrapping GitHub displays this file poorly, because it preserves the newlines. Let's try how things look without any wrapping.
2016-05-31 19:27:41 +02:00
* When filing an issue, specify the **systemd** **version** you are experiencing the issue with. Also, indicate which **distribution** you are using.
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 12:02:03 +01:00
* Please include an explanation how to reproduce the issue you are pointing out.
CONTRIBUTING: remove line wrapping GitHub displays this file poorly, because it preserves the newlines. Let's try how things look without any wrapping.
2016-05-31 19:27:41 +02:00
Following these guidelines makes it easier for us to process your issue, and ensures we won't close your issue right-away for being misfiled.
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 12:02:03 +01:00
github: how to report bugs for older distribution versions (#6146)
2017-06-20 20:20:25 +02:00
### Older downstream versions
For older versions that are still supported by your distribution please use respective downstream tracker:
* **Fedora** - [bugzilla](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&component=systemd)
docs: update information where to file bugs against RHEL/CentOS versions of systemd
2020-07-07 20:42:04 +02:00
* **RHEL/CentOS** - [bugzilla](https://bugzilla.redhat.com/) or [systemd-rhel github](https://github.com/systemd-rhel/)
github: how to report bugs for older distribution versions (#6146)
2017-06-20 20:20:25 +02:00
* **Debian** - [bugs.debian.org](https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=systemd)
docs: add a note about reporting security vulns (#5541) We *do* have the occasional security issue, where it would be nice to have non-public disclosure and time to fix the issue before it's fully public. Our github infrastracture does not make it easy to report vulnerabilities in confidential manner, so let's leverage the distro mechanisms for that. I think we're better off with this solution than leaving it up to individual reporters to discover some mechanism on their own.
2017-03-07 14:33:27 +01:00
## Security vulnerability reports
docs: create new SECURITY.md page github has special support for that name: https://help.github.com/en/articles/adding-a-security-policy-to-your-repository.
2019-08-30 11:45:42 +02:00
See [reporting of security vulnerabilities](SECURITY.md).
docs: add a note about reporting security vulns (#5541) We *do* have the occasional security issue, where it would be nice to have non-public disclosure and time to fix the issue before it's fully public. Our github infrastracture does not make it easy to report vulnerabilities in confidential manner, so let's leverage the distro mechanisms for that. I think we're better off with this solution than leaving it up to individual reporters to discover some mechanism on their own.
2017-03-07 14:33:27 +01:00
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 12:02:03 +01:00
## Posting Pull Requests
* Make sure to post PRs only relative to a very recent git master.
docs: Update links to updated docs
2018-10-30 18:31:20 +01:00
* Follow our [Coding Style](CODING_STYLE.md) when contributing code. This is a requirement for all code we merge.
* Please make sure to test your change before submitting the PR. See the [Hacking guide](HACKING.md) for details on how to do this.
CONTRIBUTING: stop mentioning "make check" Since the switch to meson this information is no longer valid. HACKING already documents how to run the test suite. See #6642
2017-08-21 09:47:07 +02:00
* Make sure to run the test suite locally, before posting your PR. We use a CI system, meaning we don't even look at your PR, if the build and tests don't pass.
CONTRIBUTING: recommend force-push (#3273)
2016-05-16 21:44:35 +02:00
* If you need to update the code in an existing PR, force-push into the same branch, overriding old commits with new versions.
Docs: Fix spelling and capitalization (#7408)
2017-11-21 14:37:16 +01:00
* After you have pushed a new version, add a comment about the new version (no notification is sent just for the commits, so it's easy to miss the update without an explicit comment). If you are a member of the systemd project on GitHub, remove the `reviewed/needs-rework` label.
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 12:02:03 +01:00
## Final Words
CONTRIBUTING: remove line wrapping GitHub displays this file poorly, because it preserves the newlines. Let's try how things look without any wrapping.
2016-05-31 19:27:41 +02:00
We'd like to apologize in advance if we are not able to process and reply to your issue or PR right-away. We have a lot of work to do, but we are trying our best!
github: add a CONTRIBUTING.md file that github shows when a PR or issue is filed github links up CONTRIBUTING.md if it exists from the issue/PR filing form. Let's add one, in the hope that people have a look before filing a PR.
2016-01-22 12:02:03 +01:00
Thank you very much for your contributions!