diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..df70dc2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contribuiting + +## Style Guide + +### Code + +We use the [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md) +as the base of how we write code. Some sections are ignored, such as: + +- [Use go.uber.org/atomic](https://github.com/uber-go/guide/blob/master/style.md) +- [Prefix Unexported Globals with _](https://github.com/uber-go/guide/blob/master/style.md), + instead, avoid using globals in general if possible. + +## License Header + +All source code files inside the project should contain the Source Code Form +License Notice of the [Mozzila Public License 2.0](https://mozilla.org/MPL/2.0/), +[which this project uses](./LICENSE), at the first lines of the project. + +``` +Copyright (c) 2026 The Lored.dev Contributors. All Rights Reserved. +Copyright (c) 2026 The DepGraph Contributors. All Rights Reserved. + +This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this +file, You can obtain one at https://mozilla.org/MPL/2.0/. + +SPDX-License-Identifier: MPL-2.0 +``` +