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

Create CONTRIBUTING.md #145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

KaushikiKrity
Copy link
Contributor

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

New Feature Submissions:

  1. Does your submission pass tests?
  2. Have you lint your code locally prior to submission?

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully ran tests with your changes locally?

Copy link
Collaborator

@AvikantSrivastava AvikantSrivastava left a comment

Choose a reason for hiding this comment

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

The content looks fine to me, make the changes that I have requested
cc @cseas @srishti-nema @mashsaxena @Shubhra-07

Also get proofreading from
@perfect10-vst or @Shubhra-07

* * *

There are mainly three sectors in which anyone can contribute to the our Website:
* Authoring a post (The Blog could be about anything realted to **Literature**.)
Copy link
Collaborator

Choose a reason for hiding this comment

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

post -> blog post


* * *

There are mainly three sectors in which anyone can contribute to the our Website:
Copy link
Collaborator

Choose a reason for hiding this comment

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

sectors -> ways


There are mainly three sectors in which anyone can contribute to the our Website:
* Authoring a post (The Blog could be about anything realted to **Literature**.)
* Reporting an issue and giving suggestions.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Reporting an issue and giving suggestions. -> Reporting an issue/bugs

There are mainly three sectors in which anyone can contribute to the our Website:
* Authoring a post (The Blog could be about anything realted to **Literature**.)
* Reporting an issue and giving suggestions.
* Localizing it or contributing to the code.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Localizing it or contributing to the code. -> Fixing known bugs

Comment on lines +17 to +25
```sh
# create a local clone of the repository
git clone https://github.com/YOUR-USERNAME/leomvit.github.io.git
# switch to the created directory
cd leomvit.github.io.git
# start local server
bundle exec jekyll serve
```
This will start the Jekyll Server.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Add instructions for setting up the repo in Docker
cc @cseas

Copy link
Member

Choose a reason for hiding this comment

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

Why do we need Docker?

* Using _Github Editor_
* Using _Local Editor_

The Second way is more preferable more begineers as there are less chances of making mistakes and all the changes one can check on Local server.
Copy link
Member

Choose a reason for hiding this comment

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

typo: begineers

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