gotosocial/vendor/github.com/godbus/dbus/v5/CONTRIBUTING.md

# How to Contribute

## Getting Started

- Fork the repository on GitHub
- Read the [README](README.markdown) for build and test instructions
- Play with the project, submit bugs, submit patches!

## Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

- Create a topic branch from where you want to base your work (usually master).
- Make commits of logical units.
- Make sure your commit messages are in the proper format (see below).
- Push your changes to a topic branch in your fork of the repository.
- Make sure the tests pass, and add any new tests as appropriate.
- Submit a pull request to the original repository.

Thanks for your contributions!

### Format of the Commit Message

We follow a rough convention for commit messages that is designed to answer two
questions: what changed and why. The subject line should feature the what and
the body of the commit should describe the why.

```
scripts: add the test-cluster command

this uses tmux to setup a test cluster that you can easily kill and
start for debugging.

Fixes #38
```

The format can be described more formally as follows:

```
<subsystem>: <what changed>
<BLANK LINE>
<why this change was made>
<BLANK LINE>
<footer>
```

The first line is the subject and should be no longer than 70 characters, the
second line is always blank, and other lines should be wrapped at 80 characters.
This allows the message to be easier to read on GitHub as well as in various
git tools.
[feature] Inherit resource limits from cgroups (#1336) When GTS is running in a container runtime which has configured CPU or memory limits or under an init system that uses cgroups to impose CPU and memory limits the values the Go runtime sees for GOMAXPROCS and GOMEMLIMIT are still based on the host resources, not the cgroup. At least for the throttling middlewares which use GOMAXPROCS to configure their queue size, this can result in GTS running with values too big compared to the resources that will actuall be available to it. This introduces 2 dependencies which can pick up resource contraints from the current cgroup and tune the Go runtime accordingly. This should result in the different queues being appropriately sized and in general more predictable performance. These dependencies are a no-op on non-Linux systems or if running in a cgroup that doesn't set a limit on CPU or memory. The automatic tuning of GOMEMLIMIT can be disabled by either explicitly setting GOMEMLIMIT yourself or by setting AUTOMEMLIMIT=off. The automatic tuning of GOMAXPROCS can similarly be counteracted by setting GOMAXPROCS yourself. 2023-01-17 20:59:04 +00:00			`# How to Contribute`

			`## Getting Started`

			`- Fork the repository on GitHub`
			`- Read the [README](README.markdown) for build and test instructions`
			`- Play with the project, submit bugs, submit patches!`

			`## Contribution Flow`

			`This is a rough outline of what a contributor's workflow looks like:`

			`- Create a topic branch from where you want to base your work (usually master).`
			`- Make commits of logical units.`
			`- Make sure your commit messages are in the proper format (see below).`
			`- Push your changes to a topic branch in your fork of the repository.`
			`- Make sure the tests pass, and add any new tests as appropriate.`
			`- Submit a pull request to the original repository.`

			`Thanks for your contributions!`

			`### Format of the Commit Message`

			`We follow a rough convention for commit messages that is designed to answer two`
			`questions: what changed and why. The subject line should feature the what and`
			`the body of the commit should describe the why.`

			```
			`scripts: add the test-cluster command`

			`this uses tmux to setup a test cluster that you can easily kill and`
			`start for debugging.`

			`Fixes #38`
			```

			`The format can be described more formally as follows:`

			```
			`<subsystem>: <what changed>`
			`<BLANK LINE>`
			`<why this change was made>`
			`<BLANK LINE>`
			`<footer>`
			```

			`The first line is the subject and should be no longer than 70 characters, the`
			`second line is always blank, and other lines should be wrapped at 80 characters.`
			`This allows the message to be easier to read on GitHub as well as in various`
			`git tools.`