参与贡献

👍🎉 首先, 感谢您花时间来贡献! 🎉👍

Xplorer目前正在开发中。 我们欢迎您参与 Xplorer 的开发。

参与

您有诸多方式可以为 Xplorer 做出贡献，其中大多数无需您撰写甚至一行代码。 您可以从这些想法开始：

• 开始使用 Xplorer ！ Go through the Tutorial guides. 每一步都如教程所写的能正常工作吗？ 如果没有，我们总是在寻求改进。 通过提出一个 Issues，让我们了解情况。
• 查看 Xplorer Issues。 若您有想修复的Issues，请提交合并请求。 标记为 头号好议题 (Good first issue) 的都是好出发点。
• Help us make the docs better. 如果您发现任何令人困惑的语文，或者任何语法错误，或者可以改进，请提交问题。
• Take a look at GitHub Discussions and give your opinion into a discussion or consider opening a pull request if you see something you want to work on.

Contributions are very welcome!

Our development process

Xplorer uses GitHub as its source of truth. The core team will work directly there. All changes will be public from the beginning.

Reporting new issues/bugs.

When opening a new issue, always make sure to fill out the issue template. We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

• One issue, one bug: Please report a single bug per issue.
• Provide reproduction steps: List all the steps necessary to reproduce the issue. The person reading your bug report should be able to follow these steps to reproduce your issue with minimal effort.

Feature Request

We use GitHub Discussions to track ideas from users. Suggest a new feature here! Great Feature Requests tend to have:

• A quick idea summary.
• What & why you wanted to add the specific feature.
• Additional references like images, links of resources about the feature, etc.

Working on Xplorer code

Prerequisite

• Node JS
• Git
• yarn
• GCC Compiler
• Code Editor, we recommend you to use VS Code

Installation

1. After cloning the repository, run yarn in the root of the repository and run yarn in the docs folder (if you want to working on Xplorer Docs).

2. To start Xplorer locally:

   • run yarn start in the root of the repository if you don't want the hot reload feature.
   • run yarn dev in the root of the repository if you want the hot reload feature.

   To start a local development server serving the Docusaurus docs, go into the docs directory and run yarn start

Gitpod

Gitpod is a Ready-to-Code environment in which you can get started immediately. Gitpod offers all dependencies pre-installed so you can just click and get started.

To get started with Gitpod, click the button below and log in with your GitHub account.

Remember to reload the Gitpod website after it loads up since it won't start the servers immediately, but by reloading, you can get it started. If you are developing the app, go to the Remote Explorer on the sidebar and visit port 6080 which opens the noVNC app server. If you are developing the docs, go to the Remote explorer but instead of port 6080, visit port 3000. You can edit normally as you do in VS Code, but if you want to use it locally, clik the hamburger menu button and click Open in VS Code. :::

Semantic commit messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: allow overriding of webpack config^--^  ^------------^|     ||     +-> Summary in present tense.|+-------> Type: chore, docs, feat, fix, refactor, style, or test.

the various types of commits:

• feat: new feature for the user
• fix: bug fix for the user
• docs: changes to the documentation
• style: formatting, missing semi-colons, etc.
• refactor: refactoring production code, eg. renaming a variable
• test: adding missing tests, refactoring tests.
• chore: updating grunt tasks etc

Use lower case not the upper case!

Working on Xplorer docs

Xplorer documentation website is built using Docusaurus 2, and its code is located at docs folder.

Prerequisite

• node js
• git
• yarn
• Code Editor, we recommend you to use VS Code

Installation

After cloning the repository, run yarn in the docs folder (you can go into the docs folder by running the cd docs command).

If you want to use Gitpod, click here for the guide on how to use Gitpod.

Local development

1. Run the yarn start command in the docs folder.
2. Edit some markdown texts in the docs folder and the website will be hot reloaded.

Pull requests

Your first pull request.

So you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.

Working on your first Pull Request? You can learn how from this free video series:

How to Contribute to an Open Source Project on GitHub

We have a list of beginner-friendly issues to help you get your feet wet in the Xplorer codebase and familiar with our contribution process. This is a great place to get started.

Proposing a change

If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also open a discussion and others will code it!

If you intend to fix a bug, please discuss it through Issues before submitting a pull request.

If you intend to add a new feature, please discuss it through GitHub Discussions to avoid multiple people working on the same feature request.

Sending a Pull Request

make sure the PR does only one thing, otherwise please split it. It is recommended to follow this commit message style.

1. Fork the repository and create your branch from master.
2. Make changes and ensure your commit message is understandable.
3. Open a PR and ensure to describe your pull request clearly.

Working on Xplorer resources

Locales

We host our locales on the crowdin. To translate it, please follow these steps:

• Sign up on Crowdin and Join our project here.
• Make sure your locale exists there, if it does not exist, leave a comment in this discussion and I'll add the language option :)
• Get familiar with the Crowdin translation UI, as you will need to use it to translate JSON and Markdown files
• Translate the content!

Priority Files to translate on Crowdin

1. src/Locales files
2. docs/docs files
3. docs/i18n/en files
4. docs/community files

Production

Once the files on src/Locales have been translated for more than 80%, we will add it into the Xplorer app, and for the docs, we will add it into production once the translation looks good!

Please comment here if you have any questions!

Files Icon

Files icons are available on src/Icon. You can add an icon by doing these steps:

• Paste the new icon in src/icon
• Edit the value of src/Components/Files/File Icon/icon.json

File Type library

The files type library is available on src/Components/Files/File Type/type.json.

You can add the type of file extension by adding value to the file.