Skip to content

A fast tool to help you to search at GitHub issues / pull request by time filters

License

Notifications You must be signed in to change notification settings

Azordev/search-by-time-github

Repository files navigation

Search by time GitHub

Forks Stargazers Issues-open Issues-closed Contributors

A tool to do search by time in GitHub repositories
app-icon
Azordev's tracking issues and pull request tool
🐞 Report a bug or 🙋‍♂️ request a feature
contributions welcome License

Search by time Github docs

A tool to help you to search at GitHub Issues / Pull Request by time filters.

Sometimes we need search on some repository, old issues or pull request, or simply needs to check the amount of issues closed in a range of time, to check our productivity or the productivity of another developer. This GUI to do search in GitHub using days filters should be easy of use for any person and should allow to you search easily in the time that you want search.

How to run the project:

As vanilla javascript project, you can run it of multiple ways, for example u can just open the index.html file in your browser since it not requires a compile process, and you will have already run the project. I propose the following way:

Pre requirements

  1. Visual Studio Code or another code editor (optional)
  2. Live Server VSCode extension or another extension for live reload

Let's to run it

  1. Open the project as a new workspace in your code editor.
  2. Start the live server extension.
  3. Start to develop!

Features

javascript css

  • Vanilla JavaScript
  • Vanilla CSS
  • Functional programming paradigm
  • Simply develop without frameworks, not dependencies, simply deploy, so fast how develop and check in your browser

Built With

  • vscode
  • Linux/GNU, macOS, Windows
  • Love and Passion for code

File Structure:

This is a little project, it requires to apply good practices to maintain simple the code, and for it we need apply a good file structure, creating the necessary modules to do each part of the code easy to modify. By it I have applied the typic "src" structure, where is saved all the code of the project. Except by index.html that is out of src to do more easy the deploy of the APP. In src you will find some interesting folders and files

assets: In this folder we place all the graphic resources. If you need to add / use a new image, this is the site.

css: Here we save all the styles of the application, doing possible to do multiple css files if is needed and maintaining the order in the code.

js: Here we save all the JavaScript code modules that we can import in the index.html file.

GIT USE:

There are some rules that apply when interacting with the project repository. This will allow us to have a standard that any developer can understand. It is important to comply with these rules so that the linting tool allows us to use the repository.

Branch:

Every time an issue is assigned to you, you must create a new branch. This can be done through the command:

git branch <name of branch>

For convenience, the branches should have a defined structure. For example, if the issue is about adding a new feature, the branch should be:

feature/#issuenumber-brief-description-of-the-feature

Suppose we have issue #12 that asks us to add a header to the main page. Then, the branch would be as follows:

feature/#12-add-header-to-main-page

If it is about solving a bug, we just have to put the word "fix" in front of it. For example:

fix/#14-remove-bad-media-queries-in-rating-component

Commits:

Like branches, commits must also follow a format. Notice how the commit message varies if it is a feature or a bug fix.

feat: added header to main page

fix: removed bad media queries in rating component

Pull Request (PR):

The PR’s are requests that as developers we make once the solution of an issue is completed and we want the code to be integrated into the master branch of the project. Before that, we must ensure that our code is fully functional and adhering to best practices.

Once we have done a commit & push in our branch, a notification with a yellow background will appear in the github repository and will ask us to continue with the PR. In the TextArea to perform the PR you will find several sections that you want to complete: A brief description of what you did, a snapshot (if applicable), the tasks that were completed and the steps to view them.

Collaborators

Israel Laguan email-icon Email me to [email protected] / linkedin-icon Connect to my Linkedin
author-pic
Victor Peña email-icon Email me to [email protected] / linkedin-icon Connect to my Linkedin
victor-pic
Emmanuel Azócar email-icon Email me to [email protected]
emmanuel-pic
Angelica Molina email-icon Email me to [email protected]
ange-pic

Contributing

contributions welcome

🤝 Contributions, issues and feature requests are welcome! Feel free to check the issues page.

Show your support

🤗 Give a ⭐️ if you like this project!

License

License

📝 This project is licensed under the Apache 2
Feel free to fork this project and improve it!

About

A fast tool to help you to search at GitHub issues / pull request by time filters

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published