Our great sponsors
-
-
-
SurveyJS
Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.
Thanks for the additional context, helps to understand your situation and resources.
> BTW, this is my project (https://github.com/Noovolari/leapp)
Looks great. A few suggestions for the first impression opening the project:
- Switch to dark mode and verify that the images work in the README and other docs. There is a logo which cannot be seen on the site, it's dark and black.
- Focus on telling the "problem to solve" and "why" in the introduction https://github.com/Noovolari/leapp#leapp I initially did not understand the term "cloud access app"
- The screenshot description is AWS focussed. https://user-images.githubusercontent.com/9497292/114399348-... If you don't know AWS specifics, it is hard to understand. Think of a more high level catchy architecture overview, or working example. Catch your marketing term with "multiple cloud access strategies". Maybe use a Gif to showcase the key items as done in the one in "key features"
- Installation links to a release download page. https://www.leapp.cloud/releases Improve this, highly recommend to create documentation guides for Windows, Linux and macOS, explaining the different commands step-by-step, more tutorial alike.
Actually, your website has a docs section, but it is not linked from the GH Readme. Suggest to link to https://docs.leapp.cloud/installation/install-leapp/ instead of the releases page.
Here's a PR to fix it: https://github.com/Noovolari/leapp/pull/215
- You are using MkDocs for the documentation. That's amazing <3
- PR template - while fixing the readme, I was confused by the template structure. Maybe get inspired by GitLab MR (similar to PR) templates? Gary Bell wrote a great blog post about them: https://www.garybell.co.uk/merge-request-templates/
- You are using a DCO which requires all commits to be signed off. That's impossible with using the browser to make direct edits to the docs, or otherwise suggestions. It may throw off contributors after their first pull request (it throws me off every time I consider contributing on a mobile device).
Did now on my desktop terminal:
cd /tmp && git clone https://github.com/dnsmichi/leapp && cd leapp && git checkout patch-1 && git commit --amend -s && git push -f
Suggestion: Document the DCO requirement more visible, e.g. with a badge in the README.
- The PR fails because because of a check https://github.com/Noovolari/leapp/runs/4971776167?check_sui...
"Error: No release type found in pull request title "Update URLs to installation docs in README". Add a prefix to indicate what kind of release this pull request corresponds to (see https://www.conventionalcommits.org/)."
That's additional work for contributors. After fixing the DCO sign-off, the next thing to do. Then again, the commit also needs a "docs: " prefix. At this point, I would have lost the desire to contribute.
- Why is the contributing.md hidden in the .github directory (https://github.com/Noovolari/leapp/blob/master/.github/CONTR...) and not present in the main repository? I was specifically looking for it at the repository top level when looking to contribute.
- https://github.com/Noovolari/leapp/blob/master/.github/CONTR... encourages you with "Please send a GitHub Pull Request to Leapp with a clear list of what you've done (read more about pull requests)."
What's a clear list of changes?
Suggestions in a new PR: https://github.com/Noovolari/leapp/pull/216
- https://docs.leapp.cloud/contributing/get-involved/ links from the docs to contributing.md As discovered above, contributing.md is more a "things to review" document. It should be the call-to-action document. Or maybe move the content from contributing.md entirely into your documentation - and only link there. I do the same with https://o11y.love/contributing/ for example
- Make it easy to spin up a development environment - I don't see any guides to do so?
Suggestion: Add Gitpod or a local Docker build and a development.md to your repository. This will be critical for your success to attract contributors.
- https://docs.leapp.cloud/contributing/project-structure/ exists but is not linked in contributing.md
- Labels help wanted / good first issue are used, but they are not explained/linked in the contributing guide. If you are not familiar with these label types, contributions are harder.
Suggestion: Fix this by adding the Call-to-action in your contribution guides.
https://github.com/Noovolari/leapp/issues?q=is%3Aissue+is%3A... + https://github.com/Noovolari/leapp/issues?q=is%3Aissue+is%3A...
Above are my first impressions starting with the project and trying to find ways to contribute. I did not read the source code yet. I'd suggest addressing them, and then focus on DevRel and marketing ideas. The first impression of a project is crucial to help seed the community plants :)
Thanks for the additional context, helps to understand your situation and resources.
> BTW, this is my project (https://github.com/Noovolari/leapp)
Looks great. A few suggestions for the first impression opening the project:
- Switch to dark mode and verify that the images work in the README and other docs. There is a logo which cannot be seen on the site, it's dark and black.
- Focus on telling the "problem to solve" and "why" in the introduction https://github.com/Noovolari/leapp#leapp I initially did not understand the term "cloud access app"
- The screenshot description is AWS focussed. https://user-images.githubusercontent.com/9497292/114399348-... If you don't know AWS specifics, it is hard to understand. Think of a more high level catchy architecture overview, or working example. Catch your marketing term with "multiple cloud access strategies". Maybe use a Gif to showcase the key items as done in the one in "key features"
- Installation links to a release download page. https://www.leapp.cloud/releases Improve this, highly recommend to create documentation guides for Windows, Linux and macOS, explaining the different commands step-by-step, more tutorial alike.
Actually, your website has a docs section, but it is not linked from the GH Readme. Suggest to link to https://docs.leapp.cloud/installation/install-leapp/ instead of the releases page.
Here's a PR to fix it: https://github.com/Noovolari/leapp/pull/215
- You are using MkDocs for the documentation. That's amazing <3
- PR template - while fixing the readme, I was confused by the template structure. Maybe get inspired by GitLab MR (similar to PR) templates? Gary Bell wrote a great blog post about them: https://www.garybell.co.uk/merge-request-templates/
- You are using a DCO which requires all commits to be signed off. That's impossible with using the browser to make direct edits to the docs, or otherwise suggestions. It may throw off contributors after their first pull request (it throws me off every time I consider contributing on a mobile device).
Did now on my desktop terminal:
cd /tmp && git clone https://github.com/dnsmichi/leapp && cd leapp && git checkout patch-1 && git commit --amend -s && git push -f
Suggestion: Document the DCO requirement more visible, e.g. with a badge in the README.
- The PR fails because because of a check https://github.com/Noovolari/leapp/runs/4971776167?check_sui...
"Error: No release type found in pull request title "Update URLs to installation docs in README". Add a prefix to indicate what kind of release this pull request corresponds to (see https://www.conventionalcommits.org/)."
That's additional work for contributors. After fixing the DCO sign-off, the next thing to do. Then again, the commit also needs a "docs: " prefix. At this point, I would have lost the desire to contribute.
- Why is the contributing.md hidden in the .github directory (https://github.com/Noovolari/leapp/blob/master/.github/CONTR...) and not present in the main repository? I was specifically looking for it at the repository top level when looking to contribute.
- https://github.com/Noovolari/leapp/blob/master/.github/CONTR... encourages you with "Please send a GitHub Pull Request to Leapp with a clear list of what you've done (read more about pull requests)."
What's a clear list of changes?
Suggestions in a new PR: https://github.com/Noovolari/leapp/pull/216
- https://docs.leapp.cloud/contributing/get-involved/ links from the docs to contributing.md As discovered above, contributing.md is more a "things to review" document. It should be the call-to-action document. Or maybe move the content from contributing.md entirely into your documentation - and only link there. I do the same with https://o11y.love/contributing/ for example
- Make it easy to spin up a development environment - I don't see any guides to do so?
Suggestion: Add Gitpod or a local Docker build and a development.md to your repository. This will be critical for your success to attract contributors.
- https://docs.leapp.cloud/contributing/project-structure/ exists but is not linked in contributing.md
- Labels help wanted / good first issue are used, but they are not explained/linked in the contributing guide. If you are not familiar with these label types, contributions are harder.
Suggestion: Fix this by adding the Call-to-action in your contribution guides.
https://github.com/Noovolari/leapp/issues?q=is%3Aissue+is%3A... + https://github.com/Noovolari/leapp/issues?q=is%3Aissue+is%3A...
Above are my first impressions starting with the project and trying to find ways to contribute. I did not read the source code yet. I'd suggest addressing them, and then focus on DevRel and marketing ideas. The first impression of a project is crucial to help seed the community plants :)
Thanks for the additional context, helps to understand your situation and resources.
> BTW, this is my project (https://github.com/Noovolari/leapp)
Looks great. A few suggestions for the first impression opening the project:
- Switch to dark mode and verify that the images work in the README and other docs. There is a logo which cannot be seen on the site, it's dark and black.
- Focus on telling the "problem to solve" and "why" in the introduction https://github.com/Noovolari/leapp#leapp I initially did not understand the term "cloud access app"
- The screenshot description is AWS focussed. https://user-images.githubusercontent.com/9497292/114399348-... If you don't know AWS specifics, it is hard to understand. Think of a more high level catchy architecture overview, or working example. Catch your marketing term with "multiple cloud access strategies". Maybe use a Gif to showcase the key items as done in the one in "key features"
- Installation links to a release download page. https://www.leapp.cloud/releases Improve this, highly recommend to create documentation guides for Windows, Linux and macOS, explaining the different commands step-by-step, more tutorial alike.
Actually, your website has a docs section, but it is not linked from the GH Readme. Suggest to link to https://docs.leapp.cloud/installation/install-leapp/ instead of the releases page.
Here's a PR to fix it: https://github.com/Noovolari/leapp/pull/215
- You are using MkDocs for the documentation. That's amazing <3
- PR template - while fixing the readme, I was confused by the template structure. Maybe get inspired by GitLab MR (similar to PR) templates? Gary Bell wrote a great blog post about them: https://www.garybell.co.uk/merge-request-templates/
- You are using a DCO which requires all commits to be signed off. That's impossible with using the browser to make direct edits to the docs, or otherwise suggestions. It may throw off contributors after their first pull request (it throws me off every time I consider contributing on a mobile device).
Did now on my desktop terminal:
cd /tmp && git clone https://github.com/dnsmichi/leapp && cd leapp && git checkout patch-1 && git commit --amend -s && git push -f
Suggestion: Document the DCO requirement more visible, e.g. with a badge in the README.
- The PR fails because because of a check https://github.com/Noovolari/leapp/runs/4971776167?check_sui...
"Error: No release type found in pull request title "Update URLs to installation docs in README". Add a prefix to indicate what kind of release this pull request corresponds to (see https://www.conventionalcommits.org/)."
That's additional work for contributors. After fixing the DCO sign-off, the next thing to do. Then again, the commit also needs a "docs: " prefix. At this point, I would have lost the desire to contribute.
- Why is the contributing.md hidden in the .github directory (https://github.com/Noovolari/leapp/blob/master/.github/CONTR...) and not present in the main repository? I was specifically looking for it at the repository top level when looking to contribute.
- https://github.com/Noovolari/leapp/blob/master/.github/CONTR... encourages you with "Please send a GitHub Pull Request to Leapp with a clear list of what you've done (read more about pull requests)."
What's a clear list of changes?
Suggestions in a new PR: https://github.com/Noovolari/leapp/pull/216
- https://docs.leapp.cloud/contributing/get-involved/ links from the docs to contributing.md As discovered above, contributing.md is more a "things to review" document. It should be the call-to-action document. Or maybe move the content from contributing.md entirely into your documentation - and only link there. I do the same with https://o11y.love/contributing/ for example
- Make it easy to spin up a development environment - I don't see any guides to do so?
Suggestion: Add Gitpod or a local Docker build and a development.md to your repository. This will be critical for your success to attract contributors.
- https://docs.leapp.cloud/contributing/project-structure/ exists but is not linked in contributing.md
- Labels help wanted / good first issue are used, but they are not explained/linked in the contributing guide. If you are not familiar with these label types, contributions are harder.
Suggestion: Fix this by adding the Call-to-action in your contribution guides.
https://github.com/Noovolari/leapp/issues?q=is%3Aissue+is%3A... + https://github.com/Noovolari/leapp/issues?q=is%3Aissue+is%3A...
Above are my first impressions starting with the project and trying to find ways to contribute. I did not read the source code yet. I'd suggest addressing them, and then focus on DevRel and marketing ideas. The first impression of a project is crucial to help seed the community plants :)