Skip to content
This repository has been archived by the owner on Mar 16, 2024. It is now read-only.

Updating/adding contributing guide #100

Merged
merged 3 commits into from
Nov 9, 2023
Merged

Updating/adding contributing guide #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b172e8c
Create CONTRIBUTING.md
ItsMePepijn Nov 9, 2023
6c9b23a
Update README.md to link to CONTRIBUTING.md
ItsMePepijn Nov 9, 2023
12650d9
wording fix
ItsMePepijn Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

# Contributing
If you wish to contribute to the ArkAscendedServerManager codebase or documentation, feel free to fork the repository and submit a pull request. If you don't know what to do you can head over to the [Issues page](https://github.com/JensvandeWiel/ArkAscendedServerManager/issues) and look for a feature you can make! *tip: if you're starting out with contributing, look for an issue with the 'good first issue' tag ;)*

## Recommended Workflow
To comfortably work on the codebase, please do the following:
1. Fork & clone the repository, and make sure you're on the **main** branch.
2. Run `wails dev` to start the dev server. ([install](https://wails.io/docs/gettingstarted/installation))
3. Use `git checkout -b feature/branch_name` to create and switch to your own feature branch. *(`bug/branch_name` for bug fixes)*
4. Code some awesome things!
5. Test your code and make sure it works/doesn't break any other features.
6. Run `wails build` one last time to make sure the build process still succeeds.
7. Push your changes to your own forked repo.
8. [Create a pull request](https://github.com/JensvandeWiel/ArkAscendedServerManager/compare).
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ Steamcmd is not yet packaged with the app, if you want to create a server with A
6. Start the app again and create a server.
7. :tada: You can run your server!
### Contributing
Ask one of **the core contributors** in the [discord server](https://discord.gg/pBfmFuK2Wa) to give you contributor role, then you can ask what to do. Or you can just make a pull request with some code you've written.
Check out the [Contributing Guide](https://github.com/JensvandeWiel/ArkAscendedServerManager) to get started with contributing! Once your first contribution is merged you can head over to our [Discord Server](https://discord.gg/vcfNeZ3SDN) and ask for the 'Contributor' role :D
### :warning: Watch out :warning:
This project is still only in very early alpha, so there are still many features to come!
Loading