Update documentation, and other files [skip ci]

47degrees · Mar 2, 2022 · c22e6ab · c22e6ab
1 parent d7a9ed3
commit c22e6ab
Show file tree

Hide file tree

Showing 9 changed files with 145 additions and 1 deletion.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -0,0 +1,18 @@
+[comment]: <> (Don't edit this file!)
+[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
+[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
+
+# Authors
+
+## Maintainers
+
+The maintainers of the project are:
+
+- [![jisantuc](https://avatars.githubusercontent.com/u/5702984?v=4&s=20) **James Santucci (jisantuc)**](https://github.com/jisantuc)
+
+## Contributors
+
+These are the people that have contributed to the _sbt-energymonitor_ project:
+
+- [![jisantuc](https://avatars.githubusercontent.com/u/5702984?v=4&s=20) **jisantuc**](https://github.com/jisantuc)
+- [![47erbot](https://avatars.githubusercontent.com/u/24799081?v=4&s=20) **47erbot**](https://github.com/47erbot)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,22 @@
+[comment]: <> (Don't edit this file!)
+[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
+[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
+
+# Code of Conduct
+
+We are committed to providing a friendly, safe and welcoming
+environment for all, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal
+appearance, body size, race, ethnicity, age, religion, nationality, or
+other such characteristics.
+
+Everyone is expected to follow the
+[Scala Code of Conduct](https://www.scala-lang.org/conduct/) when
+discussing the project on the available communication channels. If you
+are being harassed, please contact us immediately so that we can
+support you.
+
+## Moderation
+
+For any questions, concerns, or moderation requests please contact a
+[member of the project](AUTHORS.md#maintainers).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+[comment]: <> (Don't edit this file!)
+[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
+[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
+
+# Contributing
+
+Discussion around _sbt-energymonitor_ happens in the [GitHub issues](https://github.com/47degrees/sbt-energymonitor/issues) and [pull requests](https://github.com/47degrees/sbt-energymonitor/pulls).
+
+Feel free to open an issue if you notice a bug, have an idea for a feature, or have a question about
+the code. Pull requests are also welcome.
+
+People are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md) when discussing _sbt-energymonitor_ on the Github page or other venues.
+
+If you are being harassed, please contact one of [us](AUTHORS.md#maintainers) immediately so that we can support you. In case you cannot get in touch with us please write an email to [47 Degrees Open Source](mailto:[email protected]).
+
+## How can I help?
+
+_sbt-energymonitor_ follows a standard [fork and pull](https://help.github.com/articles/using-pull-requests/) model for contributions via GitHub pull requests.
+
+The process is simple:
+
+ 1. Find something you want to work on
+ 2. Let us know you are working on it via GitHub issues/pull requests
+ 3. Implement your contribution
+ 4. Write tests
+ 5. Update the documentation
+ 6. Submit pull request
+
+You will be automatically included in the [AUTHORS.md](AUTHORS.md#contributors) file as contributor in the next release.
+
+If you encounter any confusion or frustration during the contribution process, please create a GitHub issue and we'll do our best to improve the process.
diff --git a/LICENSE.md b/LICENSE.md
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (C)  @YEAR_RANGE@ @COPYRIGHT_OWNER@
+   Copyright (C)  2022 47 Degrees Open Source <https://www.47deg.com>
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/NOTICE.md b/NOTICE.md
@@ -0,0 +1,9 @@
+[comment]: <> (Don't edit this file!)
+[comment]: <> (It is automatically updated after every release of https://github.com/47degrees/.github)
+[comment]: <> (If you want to suggest a change, please open a PR or issue in that repository)
+
+sbt-energymonitor
+
+Copyright (c) 2022 47 Degrees Open Source. All rights reserved.
+
+Licensed under Apache-2.0. See [LICENSE](LICENSE.md) for terms.
diff --git a/src/main/scala/energymonitor/EnergyMonitorPlugin.scala b/src/main/scala/energymonitor/EnergyMonitorPlugin.scala
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2022 47 Degrees Open Source <https://www.47deg.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package energymonitor
 
 import cats.effect.IO

diff --git a/src/main/scala/energymonitor/rapl/implicits.scala b/src/main/scala/energymonitor/rapl/implicits.scala
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2022 47 Degrees Open Source <https://www.47deg.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package energymonitor.rapl
 
 import cats.Eq

diff --git a/src/main/scala/energymonitor/rapl/sRAPL.scala b/src/main/scala/energymonitor/rapl/sRAPL.scala
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2022 47 Degrees Open Source <https://www.47deg.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package energymonitor
 
 import cats.MonadError

diff --git a/src/test/scala/energymonitor/EnergymonitorSpec.scala b/src/test/scala/energymonitor/EnergymonitorSpec.scala
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2022 47 Degrees Open Source <https://www.47deg.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package energymonitor
 
 import cats.effect.IO