Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Contribution Guidelines #1087

Merged
merged 10 commits into from
Oct 13, 2023
Merged

Update Contribution Guidelines #1087

merged 10 commits into from
Oct 13, 2023

Conversation

Traxmaxx
Copy link
Contributor

Problem

Improve the contribution guidelines with missing informations for frontend development onboarding. Also add links to internal document references and cross-reference the QUickstart Guide for adding a config.toml

Solution

Instruvtions are missing some key steps which is referecnes externally. This PR add the missing steps and cross-reference external documentation for things like setting up the config.toml

Changes Made

  • Link references to internal sections
  • Fix spelling mistakes
  • Add content for missings steps
  • Improve the README inside /dashboard for frontend specific thigns (TBD)

How to Test

Read the .md files and make sure they parse fine. That's it.

Screenshots

None needed. Use GitHub Markdown preview

Notes

Checklist

  • Code follows the contributing guidelines
  • Changes have been thoroughly tested
  • Documentation has been updated, if necessary
  • Any dependencies have been added to the project, if necessary

Reviewers

@[username of the reviewer]

@Traxmaxx Traxmaxx changed the title Feature/tech 1698 Feature/TECH-1698 Oct 12, 2023
Copy link
Contributor

@jakepage91 jakepage91 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just these three comments. Everything thing else looks super great and clean!

dashboard/README.md Outdated Show resolved Hide resolved
dashboard/README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@Traxmaxx Traxmaxx marked this pull request as ready for review October 13, 2023 09:12
@Traxmaxx Traxmaxx changed the title Feature/TECH-1698 Update Contribution Guidelines Oct 13, 2023
@mlabouardy mlabouardy added this to the v3.1.2 milestone Oct 13, 2023
@mlabouardy mlabouardy merged commit 6215b4c into develop Oct 13, 2023
3 checks passed
@mlabouardy mlabouardy deleted the feature/tech-1698 branch October 13, 2023 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants