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

TME-2684 - Add docs and contributing guidelines #56

Merged
merged 14 commits into from
Apr 16, 2024
Merged

TME-2684 - Add docs and contributing guidelines #56

merged 14 commits into from
Apr 16, 2024

Conversation

closb
Copy link
Contributor

@closb closb commented Apr 10, 2024

I added doc comments and edited existing docs to adhere to best practices. I also added README in examples directory that provide a brief explanation of the setup and pertinent information.

The docs contain the recommended sections for open source documentation. Minus the structure, the edits to the context were minimal and mostly consisted of grammar for brevity and clarity.

I have added the wip prefix to files until we come to a consensus and agree on context and format.

That said, the current contributing file is missing information and is a boilerplate which is taken directly from the contributors covenant known as the de-facto standard for open source projects.

I have also added context and references to the Jira ticket to explain the path I chose and reasons why.

@closb closb requested review from intertwine, bachu20 and Jillory April 10, 2024 15:59
@bachu20
Copy link
Contributor

bachu20 commented Apr 11, 2024

Suggested documentation changes look amazing, thanks for the awesome work on this! 🔥
Only thing left before this is good to go is to handle the pre-commit & formatting failures. Otherwise the changes are good to merge in (after removing the wip file prefixes) as far as I'm concerned.

@closb
Copy link
Contributor Author

closb commented Apr 11, 2024

@bachu20 sounds good, thanks brother, it was definitely a learning experience! I'll bring it up during standup that this is ready to go, the only remaining issue is the contributing doc. I posted on the ticket what needs to be, or should be changed.

@bachu20
Copy link
Contributor

bachu20 commented Apr 16, 2024

@closb I'll create a separate task to address the security concerns noted by the scan-tf task.

@closb
Copy link
Contributor Author

closb commented Apr 16, 2024

@bachu20 sounds good, thanks!

@closb closb merged commit a000f62 into main Apr 16, 2024
3 of 4 checks passed
@closb closb deleted the TME-2684 branch April 16, 2024 16:28
@closb closb restored the TME-2684 branch April 18, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants