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

[Docs] Publish Code Style Guide #2694

Closed
2 tasks done
brucearctor opened this issue Jul 14, 2022 · 9 comments
Closed
2 tasks done

[Docs] Publish Code Style Guide #2694

brucearctor opened this issue Jul 14, 2022 · 9 comments
Labels
documentation Improvements or additions to documentation stale untriaged This issues has not yet been looked at by the Maintainers

Comments

@brucearctor
Copy link
Contributor

Description

It is great for a project to have consistent code formatting/style. This is often accomplished by a linting, and as part of pre-commit tests. But, it would also be helpful if a styleguide were published to make the choices/opinions explicit.

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@brucearctor brucearctor added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Jul 14, 2022
@samhita-alla
Copy link
Contributor

@SmritiSatyanV, could you link the google doc we have? Should we have the page in the community tab of our docs?

The task here is to convert the google doc to a flyte doc page.

@SmritiSatyanV
Copy link
Contributor

@SmritiSatyanV
Copy link
Contributor

The user specifies code guide here. What we have is a documentation style guide. I think we need to have a separate code style guide..

@samhita-alla
Copy link
Contributor

Oh, okay. Do we have an issue for porting the doc style guide to our docs?

@SmritiSatyanV
Copy link
Contributor

#2388 @samhita-alla

@akarsh-jain-790
Copy link

Hey, I would like to work on this issue.

@akarsh-jain-790
Copy link

https://docs.google.com/document/d/1rhEZqd3Ae8Y9HUxg7yF6LarHrfIHKnPyeke8aMSPgis/edit?usp=sharing - here's the google doc

If I'm right I just have to convert the google doc to a flyte doc page ?

akarsh-jain-790 added a commit to akarsh-jain-790/flyte that referenced this issue Oct 8, 2022
akarsh-jain-790 added a commit to akarsh-jain-790/flyte that referenced this issue Oct 8, 2022
@github-actions
Copy link

github-actions bot commented Sep 3, 2023

Hello 👋, This issue has been inactive for over 9 months. To help maintain a clean and focused backlog, we'll be marking this issue as stale and will close the issue if we detect no activity in the next 7 days. Thank you for your contribution and understanding! 🙏

@github-actions github-actions bot added the stale label Sep 3, 2023
@github-actions
Copy link

Hello 👋, This issue has been inactive for over 9 months and hasn't received any updates since it was marked as stale. We'll be closing this issue for now, but if you believe this issue is still relevant, please feel free to reopen it. Thank you for your contribution and understanding! 🙏

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 12, 2023
@eapolinario eapolinario reopened this Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation stale untriaged This issues has not yet been looked at by the Maintainers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants