Skip to content

Commit f691a94

Browse files
committed
📝 updated Readme and contributing guide
1 parent b869ec5 commit f691a94

File tree

4 files changed

+16
-6
lines changed

4 files changed

+16
-6
lines changed

.DS_Store

-6 KB
Binary file not shown.

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules
22
/.DS_Store
3-
src/.DS_Store
3+
src/.DS_Store
4+
.DS_Store

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,17 @@
33

44

55

6-
[![Build Status](https://dev.azure.com/junipd2/jirax/_apis/build/status/junipdewan.jirax?branchName=master)](https://dev.azure.com/junipd2/jirax/_build/latest?definitionId=4&branchName=master) ![made with nodejs](https://img.shields.io/badge/madewith-node.js-green.svg) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![license](https://img.shields.io/github/license/visionmedia/superagent.svg)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
6+
7+
[![Build Status](https://dev.azure.com/junipd2/jirax/_apis/build/status/junipdewan.jirax?branchName=master)](https://dev.azure.com/junipd2/jirax/_build/latest?definitionId=4&branchName=master) ![npm](https://img.shields.io/npm/dm/jirax.svg) ![made with nodejs](https://img.shields.io/badge/madewith-node.js-green.svg) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![license](https://img.shields.io/github/license/visionmedia/superagent.svg)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
78

89
A CLI tool for [JIRA](`https://www.atlassian.com/software/jira`) for day to day usage with JIRA.Speed up your JIRA activity with this CLI tool.
910

1011

1112
![Interface](assets/cli_help.jpg?raw=true "CLI Help Preview")
1213

14+
### Asciicast Preview
15+
[![asciicast](https://asciinema.org/a/251931.png)](https://asciinema.org/a/251931)
16+
1317

1418
## Prerequisites
1519

@@ -69,9 +73,7 @@ After cloning the repository. Run this command this command will automatically c
6973

7074
## Contribution
7175

72-
Here in the CLI tool only few of the use cases have been implemented which are more basic usage with JIRA client.
73-
You can help with code contribution to add more functionality to the CLI tool.
74-
76+
We hope that you will consider contributing to Jirax. Please read this short overview [Contribution Guidelines](https://github.com/junipdewan/jirax/blob/master/CONTRIBUTING.md) for some information about how to get started
7577

7678
## MIT License
7779

contributing.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Contributing
1+
# How to contribute to Jirax
2+
3+
Thanks for your interest on contributing to Jirax ! Here are a few general guidelines on contributing and reporting bugs to Jirax that we ask you to take a look first. Notice that all of your interactions in the project are expected to follow our [Code of Conduct](#code-of-conduct).
4+
25

36
When contributing to this repository, please first discuss the change you wish to make via issue,
47
email, or any other method with the owners of this repository before making a change.
@@ -16,6 +19,10 @@ Please note we have a code of conduct, please follow it in all your interactions
1619
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
1720
do not have permission to do that, you may request the second reviewer to merge it for you.
1821

22+
Thanks again for your interest on contributing to the project!
23+
24+
❤️
25+
1926
## Code of Conduct
2027

2128
### Our Pledge

0 commit comments

Comments
 (0)