Skip to content

Commit

Permalink
Properly credit contributors (#33)
Browse files Browse the repository at this point in the history
* Add `AUTHORS.md` file.
* Add exe to automatically regenerate this list.
* Updated README
  • Loading branch information
LeeTwentyThree committed May 11, 2023
1 parent 4bd745a commit 2f91173
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 0 deletions.
16 changes: 16 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Nautilus Contributors
We thank all of the following individuals for their contributions to Nautilus. This list includes everyone who worked on the original version, [SMLHelper](https://github.com/SubnauticaModding/SMLHelper). Nautilus would not be the same without them!

| Name | Picture | Commits | Name | Picture | Commits | Name | Picture | Commits |
| ---- | --------------- | ------ | ---- | --------------- | ------ | ---- | --------------- | ------ |
| [MrPurple6411](https://github.com/MrPurple6411) | <img src="https://avatars.githubusercontent.com/u/7858500?v=4" width="50"> | 433 | [PrimeSonic](https://github.com/PrimeSonic) | <img src="https://avatars.githubusercontent.com/u/39146191?v=4" width="50"> | 312 | [Metious](https://github.com/Metious) | <img src="https://avatars.githubusercontent.com/u/71298690?v=4" width="50"> | 287 |
| [toebeann](https://github.com/toebeann) | <img src="https://avatars.githubusercontent.com/u/45315526?v=4" width="50"> | 228 | [ahk1221](https://github.com/ahk1221) | <img src="https://avatars.githubusercontent.com/u/16101353?v=4" width="50"> | 212 | [Alexejhero](https://github.com/Alexejhero) | <img src="https://avatars.githubusercontent.com/u/32238504?v=4" width="50"> | 207 |
| [zorgesho](https://github.com/zorgesho) | <img src="https://avatars.githubusercontent.com/u/53096970?v=4" width="50"> | 42 | [JKohlman](https://github.com/JKohlman) | <img src="https://avatars.githubusercontent.com/u/2236351?v=4" width="50"> | 35 | [LeeTwentyThree](https://github.com/LeeTwentyThree) | <img src="https://avatars.githubusercontent.com/u/31892011?v=4" width="50"> | 29 |
| [K07H](https://github.com/K07H) | <img src="https://avatars.githubusercontent.com/u/8804812?v=4" width="50"> | 22 | [Vlad-00003](https://github.com/Vlad-00003) | <img src="https://avatars.githubusercontent.com/u/31519848?v=4" width="50"> | 11 | [EckoTheBat](https://github.com/EckoTheBat) | <img src="https://avatars.githubusercontent.com/u/31031556?v=4" width="50"> | 11 |
| [Cattlesquat](https://github.com/Cattlesquat) | <img src="https://avatars.githubusercontent.com/u/3742246?v=4" width="50"> | 5 | [DingoDjango](https://github.com/DingoDjango) | <img src="https://avatars.githubusercontent.com/u/3172881?v=4" width="50"> | 4 | [NeisesMike](https://github.com/NeisesMike) | <img src="https://avatars.githubusercontent.com/u/17013743?v=4" width="50"> | 3 |
| [celvro](https://github.com/celvro) | <img src="https://avatars.githubusercontent.com/u/6541615?v=4" width="50"> | 3 | [brett-taylor](https://github.com/brett-taylor) | <img src="https://avatars.githubusercontent.com/u/3868773?v=4" width="50"> | 2 | [DeadMor0z](https://github.com/DeadMor0z) | <img src="https://avatars.githubusercontent.com/u/13347404?v=4" width="50"> | 1 |
| [EldritchCarMaker](https://github.com/EldritchCarMaker) | <img src="https://avatars.githubusercontent.com/u/97289845?v=4" width="50"> | 1 | [RamuneNeptune](https://github.com/RamuneNeptune) | <img src="https://avatars.githubusercontent.com/u/94365980?v=4" width="50"> | 1 | [SamuramongeDev](https://github.com/SamuramongeDev) | <img src="https://avatars.githubusercontent.com/u/76671705?v=4" width="50"> | 1 |

If you notice a problem with this file, feel free to report an issue in the repository.

If you would like to update this file manually, clone the repository, run the AuthorTableGenerator.exe in the AuthorsTableGenerator folder and send a Pull Request.
Binary file added AuthorsTableGenerator/AuthorTableGenerator.dll
Binary file not shown.
Binary file added AuthorsTableGenerator/AuthorTableGenerator.exe
Binary file not shown.
9 changes: 9 additions & 0 deletions AuthorsTableGenerator/AuthorTableGenerator.runtimeconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"runtimeOptions": {
"tfm": "net6.0",
"framework": {
"name": "Microsoft.NETCore.App",
"version": "6.0.0"
}
}
}
11 changes: 11 additions & 0 deletions AuthorsTableGenerator/table-generation-settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"columns": 3,
"pathToRepositoryRoot" : "..",
"repositoryOrganizationOrOwner": "SubnauticaModding",
"repositoryName": "Nautilus",
"fileName": "AUTHORS.md",
"title": "Nautilus Contributors",
"description": "We thank all of the following individuals for their contributions to Nautilus. This list includes everyone who worked on the original version, [SMLHelper](https://github.com/SubnauticaModding/SMLHelper). Nautilus would not be the same without them!",
"footer": "If you notice a problem with this file, feel free to report an issue in the repository.\n\nIf you would like to update this file manually, clone the repository, run the AuthorTableGenerator.exe in the AuthorsTableGenerator folder and send a Pull Request.",
"showCommits": true
}
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [🌐 About](#about)
- [⬇️ Installation](#installation)
- [📚 Resources / links](#links)
- [❤️ Contributors](#contributors)
- [🤝 Contributing](#contributing)

## About
Expand Down Expand Up @@ -45,6 +46,14 @@ If you have any trouble installing the mod, please join our [Discord server](htt
* Other links:
* [Subnautica Modding Discord Server](https://discord.gg/UpWuWwq)

## Contributors
To everyone who has spent the time to contribute to Nautilus and/or SMLHelper, we cannot thank you enough!
* [Elaborate list of all current and previous contributors to Nautilus](https://github.com/SubnauticaModding/Nautilus/blob/authors-list/AUTHORS.md)
* [SMLHelper repository (contains any lost contributor info)](https://github.com/SubnauticaModding/SMLHelper)
* [Raw, complete, and up-to-date contributor data from the GitHub API](https://api.github.com/repos/SubnauticaModding/Nautilus/contributors)

###### An unusual issue when mirroring the repository has caused many SMLHelper contributors to disappear from the widget on Nautilus's GitHub page, even if their contributions were correctly carried over to Nautilus.

## Contributing
Please read through our [Contribution Guidelines](CONTRIBUTING.md) before submitting a pull request. We welcome all kinds of contributions.
If you have an idea for a feature or a bug to report but are not capable of writing code, [submit an issue](https://github.com/SubnauticaModding/Nautilus/issues/new) instead.

0 comments on commit 2f91173

Please sign in to comment.