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

feat: Update readme on how to use the app and creating filters #9

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# jira-auto-scheduler
A JIRA auto-scheduling application for product management

# How to retrieve CSV from Jira
1) On the navigation bar of Jira select "Filters. You can view your recent filters, see all filters or do an advance issue search.
2) Select view all filters from the dropdown. You can select an exisiting filter or create a new one with the criterias you'd like.
3) Select a filter.
4) Select "Export" and in the dropdown menu select the file format of CSV.

# How to create a new Filter

1) On the navigation bar of Jira select "Filters"
2) Select view all filters from the dropdown.
3) Select "Create Filters", you will create a filter containing all the tickets within a single project.
4) On the project dropdown select a project you'd like to have a filter for.
5) Select "Save as" and name the filter and select submit

# How to run locally
1) If python isn't installed go to https://www.python.org/
2) Navigate to the root directory of jira-auto-scheduler
3) Create a local server using python, in your terminal:
python 2.x: `python -m SimpleHTTPServer`
python 3.x: `python3 -m http.server`
4) Navigate to your newly generated local server in the browser with the port listed in the terminal e.g `localhost:8000`.