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

Changes made in README of the Website #275

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
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
91 changes: 67 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,82 @@
<h1 align=center>Contributing</h1>

Thank you for considering and taking the time to contribute!
The following are the guidelines for contributing to this project:
Thank you for considering and taking the time to contribute to Drifty! This section provides guidelines for developers who want to help make Drifty better. Whether you want to report bugs, request enhancements, or contribute code, your input is valuable to this open-source project.

## How to Report Bugs
Please open a new issue with steps to reproduce the problem you're experiencing.
Provide as much information as possible, including screenshots, text output, and both your expected and actual results.

If you encounter any issues or bugs while using Drifty, please help us improve by reporting them. Here's how you can report a bug:

1. **Open a New Issue**: Create a new issue in the [GitHub issue tracker](https://github.com/SaptarshiSarkar12/Drifty/issues/new/choose) with details about the bug.
2. **Provide Details**: Include steps to reproduce the problem, along with as much information as possible. This may include screenshots, text output, and both your expected and actual results.
3. **Be Thorough**: The more details you provide, the easier it is for us to understand and fix the issue.

## How to Request Enhancements
First, please refer to the [issues](https://github.com/SaptarshiSarkar12/Drifty/issues) section of this project and search [the repository's GitHub issues](https://github.com/SaptarshiSarkar12/Drifty/issues) to make sure that your idea has not been (or is not still) considered.
Then, please [create a new issue in the GitHub repository](https://github.com/SaptarshiSarkar12/Drifty/issues/new/choose) describing the enhancement you would like to have.
Be sure to include as much detail as possible including step-by-step descriptions, specific examples, screenshots or mockups, and providing a reason why the enhancement might be worthwhile.

## Here are some quick guide of some common ways to contribute :
### Issues
[**Issues**](https://github.com/SaptarshiSarkar12/Drifty/issues/new/choose) are very valuable to this project. Please check if any similar issues are already present. If not, then feel free to open that issue.
- **Feature 💡 Requests** are valuable sources of enhancements which the project can make.
- **Bug 🐞 Reports** show where this project is lacking and errors come up.
- With a **question**, you show where contributors can improve the user experience.
We welcome your ideas for enhancing Drifty. Before submitting an enhancement request, please check the [existing issues](https://github.com/SaptarshiSarkar12/Drifty/issues) to ensure that your idea has not already been considered. To request an enhancement:

1. **Create a New Issue**: Use the [GitHub issue tracker](https://github.com/SaptarshiSarkar12/Drifty/issues/new/choose) to create a new issue.
2. **Describe the Enhancement**: Provide a detailed description of the enhancement you would like to see. Include step-by-step descriptions, specific examples, screenshots, or mockups.
3. **Explain Why**: Explain why you believe the enhancement would be valuable or beneficial to Drifty.

## Ways to Contribute

There are several ways you can contribute to the Drifty project:

### 1. Issues

Issues are valuable contributions to this project. Here are some common types of issues you can create:

- **Feature Requests**: Suggest new features or improvements to existing ones.
- **Bug Reports**: Report any issues or errors you encounter while using Drifty.
- **Questions**: Seek clarifications or assistance, helping us improve the user experience.

### 2. Projects

Our [Projects](https://github.com/users/SaptarshiSarkar12/projects/3) page lists tasks that are either completed, in progress, or ideas left to be incorporated in the project. You can work on the To-Do tasks by creating the issue (if not present) and getting yourself assigned.

### 3. Pull Requests

Pull requests are a great way to contribute code changes to Drifty. If you want to contribute code, follow these steps:

1. **Fork the Repository**: Start by forking the [Drifty repository](https://github.com/SaptarshiSarkar12/Drifty) to your own GitHub account. You can do this by clicking the "Fork" button on the top right of the repository page.

2. **Clone the Repository**: After forking, clone your forked repository into your local development environment using the following command in your terminal:

```bash
git clone git@github.com:YourGitHubUsername/Drifty.git
```

Replace `YourGitHubUsername` with your actual GitHub username.

![Clone Drifty](https://user-images.githubusercontent.com/105960032/194497334-856c610e-39cd-4538-a998-18afb10dac04.gif) </p>

3. **Open an Issue**: Before making any changes, open an [issue](https://github.com/SaptarshiSarkar12/Drifty/issues/new/choose) to describe the changes or improvements you plan to make. This helps in discussing and coordinating the work with project maintainers.

4. **Make Your Changes**: Using an Integrated Development Environment (IDE), such as [IntelliJ IDEA](https://www.jetbrains.com/idea/), make the desired changes to the codebase. Ensure that your changes align with the issue you opened.

5. **Open a Pull Request (PR)**: Once your changes are ready, open a Pull Request (PR) from your forked repository to the main Drifty repository. In the PR description, be sure to reference the issue that your changes address. This helps maintainers understand the context of your PR.

6. **Review and Collaboration**: The Pull Request will be reviewed by project maintainers and contributors. Be prepared to make any necessary adjustments based on feedback. Collaborate with the community to refine your changes.

7. **Get Your PR Merged**: After thorough review and approval by maintainers, your PR will be merged into the main Drifty repository. Congratulations on your contribution!

8. **Show Your Support**: If you enjoyed contributing to Drifty, consider leaving a ⭐️ on the [GitHub repository](https://github.com/SaptarshiSarkar12/Drifty). Your support is greatly appreciated!

9. **Join Our Discord Server**: To engage in discussions, share ideas, and stay updated on project developments, you're welcome to join our [Discord Server](https://discord.gg/DeT4jXPfkG). It's a great way to connect with the community.

#### Providing Clear Intent

When submitting a pull request, be clear about the problem you're solving or the feature you're adding. For example:

- **Bad**: "Added some files"
- **Good**: "Added files to make the app more user-friendly"

### Projects
[**Projects**](https://github.com/users/SaptarshiSarkar12/projects/3) lists the **tasks _completed_, _in progress_ and _the ideas left to be incorporated_ in the project**. You can work on the **To-Do tasks** by _**creating the issue** (if not present) and **getting yourself assigned**_.
A clear description helps reviewers understand the problem and the solution you're proposing.

### Pull Requests
[**Pull requests**](https://github.com/SaptarshiSarkar12/Drifty/pulls) are a great way to get your ideas (through code changes) into this project. Please open an issue at first, describing the changes you want to make, then feel free to open a PR (Pull Request).
We appreciate your contributions to Drifty, and together we can make it even better! Thank you for being part of our open-source community.

#### Does it state intent ?
You should be _clear_ which problem you're trying to _solve or the feature you want to include_ with your contribution.

For example:

> Added some files

Doesn't tell me anything about why you're doing that

> Add files to make the app more user friendly

Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it.
80 changes: 20 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,66 +57,26 @@ The [_Website_](https://saptarshisarkar12.github.io/Drifty/) of **Drifty** is bu
- [Next.js](https://nextjs.org/) - A JavaScript framework for building server-rendered React applications.
- [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework.

## Quickstart 🚀🚀
For **Users** :
1. Open the [`website of Drifty`](https://saptarshisarkar12.github.io/Drifty/) </p>
![Homepage of Drifty Website](https://github.com/SaptarshiSarkar12/Drifty/assets/105960032/a91ddf38-6578-4a94-8802-33a14527e7a9)
2. Click on [`Download`](https://saptarshisarkar12.github.io/Drifty/#download) </p>
![Download button of Drifty Website pointed out](https://github.com/SaptarshiSarkar12/Drifty/assets/105960032/233e7a0e-17eb-4628-a4dc-421a2e9d8a1d)
3. At first, select the **Application Type** from the Dropdown menu (_By default, it is GUI_). For downloading _Drifty CLI_, select **CLI** and for _Drifty GUI_, select **GUI** from the dropdown menu. Click on the **Download Now** button based on your Operating System (_Windows, Linux, MacOS_). For **_Windows_** user, a MSI file is available for **Drifty GUI**. You can click on the **_Prefer the msi?_** text and it will download the latest MSI file for you 🎉!.</p>
![Download Webpage of Drifty](https://github.com/SaptarshiSarkar12/Drifty/assets/105960032/f8eb6151-ac6c-4383-a5d7-d03718f64cab)
4. Go to your Downloads folder and run the file you downloaded.
> Follow the on-screen instructions (For PKG and MSI files) for setting up Drifty GUI.
5. See [`Demo`](https://saptarshisarkar12.github.io/Drifty/#demo) for demonstrations on how to use the application.
6. Leave a [`star`](https://github.com/SaptarshiSarkar12/Drifty/stargazers) on GitHub if you liked the project.
7. For any issues or feature requests, you may discuss that on our [`Discord Server`](https://discord.gg/DeT4jXPfkG).

For **Contributors** :
1. Go to the [`project link on GitHub`](https://github.com/SaptarshiSarkar12/Drifty), [**`fork`**](https://github.com/SaptarshiSarkar12/Drifty/fork) this repository and clone it into your local directory by running this command in your terminal.
```bash
git clone git@github.com:SaptarshiSarkar12/Drifty.git
```
![Clone Drifty](https://user-images.githubusercontent.com/105960032/194497334-856c610e-39cd-4538-a998-18afb10dac04.gif) </p>
2. Open an [`issue`](https://github.com/SaptarshiSarkar12/Drifty/issues/new/choose) ❕ describing the changes you want to make. </p>
3. Make the changes in an IDE (preferably [`Intellij Idea`](https://www.jetbrains.com/idea/)) and open a Pull Request. Ensure that you have linked the issue to the Pull Request.
4. The Pull Request will be reviewed by the maintainers and merged if approved. ✔ </p>
5. Leave a [`star`](https://github.com/SaptarshiSarkar12/Drifty/stargazers) ⭐ on GitHub if you liked the project. </br>
6. You may join our [`Discord Server`](https://discord.gg/DeT4jXPfkG) to discuss on the changes that you want to bring.

## Safety warning ⚠ while Downloading ⬇

![image](https://user-images.githubusercontent.com/58129377/193471489-87ee10a0-f719-47ef-9d46-e5b71c611d4b.png)

It is because Microsoft Defender could not verify it is safe as it is not commonly downloaded. Feel free to proceed by following steps:
- Click on the three dots.
- Click on keep.

![image](https://user-images.githubusercontent.com/58129377/193471652-d88981c3-d903-406f-bc06-53cf77db9bf6.png)

- Click **`Show More`**.
- Click **`Keep anyway`**.

![image](https://user-images.githubusercontent.com/58129377/193471671-e047003c-95e7-43ed-8d37-d3f401b36164.png)

- Now its downloaded, you can proceed.🎉

### Report the file as safe ✔️

You can also provide your feedback to Microsoft Defender by reporting it to be Safe, by following following steps:
- Click on three dots.
- Click on **`Report this file as safe`** instead of clicking on **`Keep`**.

![image](https://user-images.githubusercontent.com/58129377/193471838-63ba50ba-e303-48b4-b7c1-b71e6c0663e7.png)

- It will take you to **`Report a download`** page. You can provide your feedback there.😄

## Contributing to the project
- Please feel free to contribute to this open-source project.
- See [**`Contribuing Guidelines`**](https://github.com/SaptarshiSarkar12/Drifty/blob/master/CONTRIBUTING.md) and [**`Projects`**](https://github.com/users/SaptarshiSarkar12/projects/3) for ways to contribute.
- **Feel free to open an [`issue`](https://github.com/SaptarshiSarkar12/Drifty/issues/new/choose)**.
- Please adhere to this project's [**`Code Of Conduct`**](https://github.com/SaptarshiSarkar12/Drifty/blob/master/CODE_OF_CONDUCT.md).
- Remember, this project follows [**`Semantic Versioning`**](https://semver.org/) for the releases.
- Join our [**`Discord Server`**](https://discord.gg/DeT4jXPfkG) to get updates on this project and discuss verbosely on the changes that you want to make.
### Quickstart

- [Quickstart](quickstart.md)

### Getting Started

- [Getting Started](getting-started.md)

### Contributing

- [Contributing](CONTRIBUTING.md)

### FAQ

- [FAQ](faq.md)

### Troubleshooting

- [Troubleshooting](troubleshooting.md)


## Stats 📊
![Repo analysis](https://repobeats.axiom.co/api/embed/9b39d68e1ca7e9523e4454b352930d61109915a1.svg)
Expand Down
47 changes: 47 additions & 0 deletions faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Frequently Asked Questions (FAQ)

This section provides answers to frequently asked questions about Drifty. If you have questions about the application, its usage, or any related topics, check here for answers.

## General Questions

### Q: What is Drifty?
**A:** Drifty is an open-source interactive file downloader system built using Java. It is available in both Command Line Interface (CLI) and Graphical User Interface (GUI) modes. Drifty is designed to simplify the process of downloading files from the internet.

### Q: Is Drifty free to use?
**A:** Yes, Drifty is completely free and open-source. You can use it without any cost.

### Q: What operating systems are supported?
**A:** Drifty supports Windows, Linux, and MacOS.

### Q: Is there a GUI version of Drifty available?
**A:** Yes, Drifty is available in both CLI and GUI versions. You can choose the version that best suits your needs.

## Usage Questions

### Q: How do I use Drifty?
**A:** Drifty offers a user-friendly interface for downloading files. For CLI usage, provide a YAML file with download links. For GUI usage, follow the on-screen instructions. Refer to the [Demo](https://saptarshisarkar12.github.io/Drifty/#demo) section for demonstrations.

### Q: Can I batch download multiple files with Drifty?
**A:** Yes, you can batch download multiple files using Drifty. Provide a YAML file with links to the files you want to download, and Drifty will handle the rest.

### Q: Where are the downloaded files stored?
**A:** By default, Drifty stores downloaded files in the default downloads folder on your computer. You can specify a different directory in the YAML file when using the CLI version.

## Troubleshooting Questions

### Q: I received a Microsoft Defender warning while downloading Drifty. What should I do?
**A:** Microsoft Defender may flag the application as it's not commonly downloaded. To proceed, click on "Keep" in the warning dialog. You can also report the file as safe to Microsoft Defender.

### Q: I encountered an issue with Drifty. How can I get help?
**A:** If you encounter issues, visit the [Drifty GitHub Issues](https://github.com/SaptarshiSarkar12/Drifty/issues) page to check for existing solutions or open a new issue describing your problem. You can also seek assistance in our [Discord Server](https://discord.gg/DeT4jXPfkG).

## Contributing Questions

### Q: How can I contribute to the Drifty project?
**A:** We welcome contributions from the community. To contribute, fork the [Drifty repository](https://github.com/SaptarshiSarkar12/Drifty), make changes, and open a pull request. Follow the [Contributing Guidelines](https://github.com/SaptarshiSarkar12/Drifty/blob/master/CONTRIBUTING.md) for more details.

### Q: Is there a Code of Conduct for contributors?
**A:** Yes, please adhere to our [Code of Conduct](https://github.com/SaptarshiSarkar12/Drifty/blob/master/CODE_OF_CONDUCT.md) when contributing to the project. We expect all contributors to follow these guidelines.

These are some common questions and answers related to Drifty. If you have more specific questions or need further assistance, feel free to reach out to the community for support.

40 changes: 40 additions & 0 deletions getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Getting Started

This section provides detailed instructions on how to get started with Drifty. Follow these steps to set up and use the application on your system.

## Installation

Before you begin, ensure that you have the required software and dependencies installed on your computer. Drifty currently supports Windows, Linux, and MacOS.

1. **Open the Website**: Visit the [Drifty website](https://saptarshisarkar12.github.io/Drifty/) to access the download options.

![Homepage of Drifty Website](https://github.com/SaptarshiSarkar12/Drifty/assets/105960032/a91ddf38-6578-4a94-8802-33a14527e7a9)

2. **Download Drifty**:
- Click on the [`Download`](https://saptarshisarkar12.github.io/Drifty/#download) button on the website.

![Download button of Drifty Website](https://github.com/SaptarshiSarkar12/Drifty/assets/105960032/233e7a0e-17eb-4628-a4dc-421a2e9d8a1d)

3. **Select Application Type**:
- On the download page, select the application type you want to download. By default, it is the GUI version. To download the CLI version, select **CLI** from the dropdown menu.

4. **Choose Your OS**:
- Choose your operating system (Windows, Linux, or MacOS).
- For Windows users, there is an option to download the MSI file for Drifty GUI. Click on the "**Prefer the MSI?**" link to download the MSI installer.

![Download Webpage of Drifty](https://github.com/SaptarshiSarkar12/Drifty/assets/105960032/f8eb6151-ac6c-4383-a5d7-d03718f64cab)

5. **Run the Installer**:
- Navigate to your Downloads folder and run the downloaded file.
- Follow the on-screen instructions to install Drifty GUI or CLI on your system.

## Usage

After successfully installing Drifty, you can start using the application. Refer to the [`Demo`](https://saptarshisarkar12.github.io/Drifty/#demo) section on the website for demonstrations on how to use Drifty for various tasks.

## Support and Feedback

If you find Drifty useful, we encourage you to show your support by leaving a [`star`](https://github.com/SaptarshiSarkar12/Drifty/stargazers) on GitHub.

For any issues, feature requests, or general discussions, you can join our [`Discord Server`](https://discord.gg/DeT4jXPfkG). We value your feedback and contributions!

Loading