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

Updated Contributing.md with workflow documentation. #346

Closed
wants to merge 1 commit into from

Conversation

ashu54-aseem
Copy link

Fixes

Fixes issue #304

Description

Adds a simple workflow diagram to the contributing doc which would act as a shorthand guide for any new contributor to get a rough idea of how the app works.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@ashu54-aseem ashu54-aseem requested a review from a team as a code owner March 12, 2021 07:14
@ashu54-aseem ashu54-aseem requested review from kgodey and removed request for a team March 12, 2021 07:14
@@ -19,6 +19,10 @@ project documentation. If you cannot find the documentation you're
looking for, please file a GitHub issue with details of what
you'd like to see documented.

## Workflow of the App

![Workflow Diagram](docs/img/workflow.jpeg)
Copy link
Member

Choose a reason for hiding this comment

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

@ashu54-aseem @obulat @zackkrida I here will prefer a markdown rather than just an image. What's your opinion?

Copy link
Author

Choose a reason for hiding this comment

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

@Cronus1007 I believe branching arrows and brackets over multiple steps would be a bit jarring and possibly confusing to see in markdown.

Copy link
Member

@Cronus1007 Cronus1007 Mar 12, 2021

Choose a reason for hiding this comment

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

I think you took the wrong path. I am telling to code in the markdowns and while seeing the documentation we can add the Previewed model of the markdown.Like this
Screenshot from 2021-03-12 13-48-31

@Cronus1007 Cronus1007 requested a review from brylie September 8, 2021 18:34
@Cronus1007
Copy link
Member

@brylie Have a look at this PR. Since issue #304 looks pretty important to me.

@brylie
Copy link
Contributor

brylie commented Sep 9, 2021

I agree that issue #304 would be valuable and suggest that we close this pull request in favor of #304.

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.

3 participants