Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 2.35 KB
Raw

Contribution Guide

Thank you for your interest in contributing to Oblivion Desktop! We appreciate your help and support. Here are some guidelines to help you get started:

Where you can help?

  • 💻 Development

    if you have programming skills that can be helpful: Pick up issues/tasks from issues page or the project board or suggest your own features, fixes, etc.
    Before starting a new task, please coordinate with the collaborators to ensure no one else is working on it.

    • Setup your development environment

      • Fork the repository
      • Follow the instructions in the DOCS.md to set up your development environment and bring up your development server
      • Make your changes and create a pull request (PR)

    • Code Style Guide

      Follow the code style guidelines. Your PR should be free from type errors. We use TypeScript, Prettier, and Husky to maintain code quality, which should be automatically enabled when you run npm install. If not, set it up with npm run prepare. Husky will run prettier before each commit to ensure code style, and tsc before every push to check for possible type errors. You can also manually fix code style errors by running npm run format.

  • 🌐 Translation

    The current translation is being done from Persian to other languages using AI. Contributions and feedback from native speakers are welcome.

    • If you want to edit the text in the app, edit the files in the src/locale folder directly. Some text may still be hardcoded and will be added to translation keys soon.
    • If you're interested in translating markdown(.md) files. just create/edit file next to original file. (we will take care of folder structure if it gets massy)

  • 💬 Discussions

    If you have any questions, suggestions, or concerns that are not addressed in this document, please feel free to open an issue or contact us directly. We are open to discussions related to the project.

⚠️ Warning

we recommend to not use your real name/account when contributing to this project. as it may causes you problem in some countries(that have problems with free circulation of information).