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

Added contributing.md #63

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

Conversation

unnati914
Copy link

Description

Fixes #2

Type of Change:

  • Code
  • Quality Assurance
  • User Interface
  • Outreach
  • Documentation

Code/Quality Assurance Only

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update (software upgrade on readme file)
  • New feature (non-breaking change which adds functionality pre-approved by mentors)

How Has This Been Tested?

Checklist:

  • My PR follows the style guidelines of this project
  • I have performed a self-review of my own code or materials
  • I have commented my code or provided relevant documentation, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • Any dependent changes have been merged

Code/Quality Assurance Only

  • My changes generate no new warnings
  • My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected)
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been published in downstream modules

Copy link
Member

@vj-codes vj-codes left a comment

Choose a reason for hiding this comment

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

@unnati914 Welcome to the community!
May I please the reason for deleting Readme, FAQ, and ways to contribute docs from here? Because it isn't in the scope of the issue and those files should mostly not be removed too.
Also, some previous commits are being shown in this PR which are not intended to solve the issue.
I suggest checkout out to a new separate branch (other than develop) and commit the changes or rebase your current one.

@unnati914
Copy link
Author

yes sorry for doing this.. it got deleted by mistake :( sorry for this

Copy link
Member

@devkapilbansal devkapilbansal left a comment

Choose a reason for hiding this comment

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

I have some requests here 👇
Will review more soon 😄

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/ellerbrock/open-source-badges/)

- Take a look at the Existing [Issues] (https://github.com/anitab-org/documentation/issues) or create your own Issues!
Copy link
Member

Choose a reason for hiding this comment

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

There should be no space here

Suggested change
- Take a look at the Existing [Issues] (https://github.com/anitab-org/documentation/issues) or create your own Issues!
- Take a look at the Existing [Issues](https://github.com/anitab-org/documentation/issues) or create your own Issues!

@@ -8,14 +8,14 @@ If you are here, it probably means you are either looking for a place to start c

## Contributing

We are glad to know that you would like to contribute to our open source projects. If you are new to our community, we strongly recommend getting through the following list.
We are glad to know that you would like to contribute to our open source projects. If you are new to our community, we strongly recommend getting through the following:-
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
We are glad to know that you would like to contribute to our open source projects. If you are new to our community, we strongly recommend getting through the following:-
We are glad to know that you would like to contribute to our open source projects. If you are new to our community, we strongly recommend getting through the following:

@@ -0,0 +1,165 @@
# 🤝***First time contributing? We will help you out.*** 👍
Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:
Refer to the following articles on the basics of Git and Github. You can also contact the Project Mentors, in case you are stuck:

Comment on lines +5 to +8
- [Getting started with Git and GitHub](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github)
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request)
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
Copy link
Member

Choose a reason for hiding this comment

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

We can also add some articles from anitab medium account 🤔

Comment on lines +44 to +52
**6.** Make changes in source code.
**7.** Stage your changes and commit

```bash
git add .
```
```bash
git commit -m "<your_commit_message>"
```
Copy link
Member

Choose a reason for hiding this comment

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

This should be written this way

6. Make changes in source code.

git add .

7. Stage your changes and commit

git commit -m "<your_commit_message>"


**8.** Push your local commits to the remote repo.

```bash
Copy link
Member

Choose a reason for hiding this comment

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

I don't think you need to add bash here

Comment on lines +163 to +165



Copy link
Member

Choose a reason for hiding this comment

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

Why so many blank lines are here?

@vj-codes
Copy link
Member

@unnati914 any update on this PR?

@unnati914
Copy link
Author

yes i will be doing this very soon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a more appealing CONTRIBUTING.md template for our projects
3 participants