Skip to content

Updated ReadMe #588

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

Merged
merged 2 commits into from
Sep 7, 2020
Merged

Conversation

AuraOfDivinity
Copy link
Collaborator

Fixes #586

Updated the docs as requested by @vaibhavdaren.

Copy link
Contributor

@ksraj123 ksraj123 left a comment

Choose a reason for hiding this comment

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

This is super helpful for someone who wants to learn how to make a pull request but I don't think that's the readme's job. Because of too much unnecessary information, contributors could skip reading it.

Please go through my comments below.


The major priority of this project has been that this platform allows users to make their project "Open Sourced" and released them under various open source Organisations, experts which hold up a ring plate on this portal.
Installing Node and NPM on Windows and macOS is straightforward because you can just use the provided installer:
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need to provide instructions on how to install node or npm on windows or Linux. We could just provide a link to official docs which explains it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@ksraj123 I agree with you but I wanted to make sure that someone new would have no issue setting up the project and contributing to it since this was what @vaibhavdaren brought up during the last meeting.


The first step of setting the donut frontend locally is to fork the original repository. This creates a copy of that repository under your own account enabling you to begin working with the code. The rights to public repositories will be such that you can view the code, but not directly commit into the repository or create branches. This allows the project owners to control changes within their codebase.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is unnecessary as its not the readme's job to tell users how to use git. If we had a procedure that's different than in other open source orgs then this would have made sense. Maybe we could just include titles of what to do, not detailed instructions.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Same as above. Let's discuss with @vaibhavdaren during today's meeting and get his opinion before removing these parts @ksraj123

Copy link
Member

@jaskiratsingh2000 jaskiratsingh2000 left a comment

Choose a reason for hiding this comment

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

Things seems to be another copy of already existing context on gitbook

@vaibhavdaren vaibhavdaren merged commit 01e9575 into codeuino:development Sep 7, 2020
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.

5 participants