Even better readme - Githubissues

FIT3170-FY-Project-7 / RABIT-COMMON

Common repository of the RABIT project, for documentation storage and cross-component interaction.

https://rabit2022.cloud.edu.au/plots

ISC License

3 stars 1 forks source link

Even better readme #25

Closed megascrapper closed 1 year ago

megascrapper commented 1 year ago

📋 | Pre-PR

Before submitting a pull request make sure you have:

[x] Read the contributing guidelines.
[x] Searched the bug tracker for similar pull requests.

[x] This PR is related to the code that is common to RABIT front- and backend and will be merged to the RABIT-COMMON repository.

📄 | Licensing

In order to be accepted and merged into RABIT, each piece of code must be released under ISC license or a compatible license.

Check one of the following options:

[x] I am the original author of this code, and I am willing to release it under the ISC license.
[ ] I am not the original author of this code, but it is released under the ISC license or a compatible license (please provide evidence).

ℹ️ | Description / Further Information

Explanation of the purpose and effect of your pull request goes here.

Provide context and examples as necessary.

Update existing screenshots to the one based on UAT
Add more screenshots and gifs showcasing the app
Fix links to documentation