Lanjut ke konten utama

Contribute

πŸ‘πŸŽ‰ First off, thanks for taking the time to contribute! πŸŽ‰πŸ‘

Xplorer is currently under development. We are welcoming contributors to collaborate on Xplorer.

Get involved#

There are many ways to contribute to Xplorer, and many of them do not involve writing any code. Here are few ideas to get started:

  • Start using Xplorer! Go trough the Tutorial guides. Does anything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
  • Look through the Xplorer issues. If you find an issue you would like to fix, open a pull request. Issues tagged as good first issue are a good place to get started.
  • Help us making the docs better. File an issue if you find anything that is confusing, any grammatical error, or can be improved.
  • Take a look at the GitHub Discussion 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 be working 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 Discussion 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#

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.

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

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 title case!

Code Structure#

.β”œβ”€β”€ build               // Web Assembly buildsβ”œβ”€β”€ docs                // Xplorer documentation sourceβ”œβ”€β”€ icons               // Icon sources for building xplorerβ”œβ”€β”€ lib                 // Library needed for xplorer appβ”‚   └── node-disk-info  // Detect user's node diskβ”‚   β”œβ”€β”€ tilt            // Tilt effect of cardβ”‚   └── wasm            // C/C++ programs for wasm└── src                 // Source code of the Xplorerβ”‚   β”œβ”€β”€ Components      // Components of Xplorerβ”‚   β”œβ”€β”€ config          // JSON files of user preferencesβ”‚   β”œβ”€β”€ Functions       // Functions that frequently being calledβ”‚   β”‚   β”œβ”€β”€ DOM         // Functions that change DOM propertyβ”‚   β”‚   β”œβ”€β”€ Files       // Functions to deal with fileβ”‚   β”‚   β”œβ”€β”€ Logs        // Log messagesβ”‚   β”‚   β”œβ”€β”€ Math        // Math functionsβ”‚   β”‚   β”œβ”€β”€ preview     // Functions to show preview of a fileβ”‚   β”‚   β”œβ”€β”€ Tab         // Functions to handle with tabβ”‚   β”‚   └── Theme       // Functions that change Xplorer themeβ”‚   β”œβ”€β”€ icon            // Icon used inside Xplorerβ”‚   β”‚   β”œβ”€β”€ contextmenu // Icon for context menu's menuβ”‚   β”‚   β”œβ”€β”€ extension   // Icon for an extension of a fileβ”‚   β”‚   β”œβ”€β”€ folder      // Icon for a folderβ”‚   β”‚   β”œβ”€β”€ settings    // Icon for settingsβ”‚   β”‚   └── sidebar     // Icon for the sidebarβ”‚   β”œβ”€β”€ Languages       // Multilingual resources for Xplorerβ”‚   └── public          // Basic HTML and CSS files└── test                // Testing code

Working on Xplorer docs#

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

Prerequisite#

Installation#

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

Local development#

  1. Run 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 DXplorer 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 enchancement but are not yet thninking about opening a pull request, you can also open an discussion and others will code it!

If you intend to fixing 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 Discussion to avoid multiple people working on a 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 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:

File Type library#

Files type library is available on src/config/type.json.

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