Skip to content

Latest commit

 

History

History
242 lines (159 loc) · 13.4 KB

CONTRIBUTING.md

File metadata and controls

242 lines (159 loc) · 13.4 KB
Raw

Contributing to Scribe-Desktop

Thank you for your interest in contributing!

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open-source project. In return, and in accordance with this project's code of conduct, other contributors will reciprocate that respect in addressing your issue or assessing changes and features.

If you have questions or would like to communicate with the team, please join us in our public Matrix chat rooms. We'd be happy to hear from you!

Contents

First steps as a contributor ⇧

Thank you for your interest in contributing to Scribe-Desktop! We look forward to welcoming you to the community and working with you to build an tools for language learners to communicate effectively :) The following are some suggested steps for people interested in joining our community:

  • Please join the public Matrix chat to connect with the community
    • Matrix is a network for secure, decentralized communication
    • Scribe would suggest that you use the Element client
    • The Desktop channel would be a great place to start!
    • Feel free to introduce yourself and tell us what your interests are if you're comfortable :)
  • Read through this contributing guide for all the information you need to contribute
  • Look into issues marked good first issue and the Projects board to get a better understanding of what you can work on
  • Check out our public designs on Figma to understand Scribes's goals and direction
  • Consider joining our bi-weekly developer sync!

Development environment ⇧

Those new to coding or wanting to develop their skills are more than welcome to contribute! The general steps to setting up a development environment are:

  1. Fork the Scribe-Desktop repo, clone your fork, and configure the remotes:

Note

Consider using SSH

Alternatively to using HTTPS as in the instructions below, consider SSH to interact with GitHub from the terminal. SSH allows you to connect without a user-pass authentication flow.

To run git commands with SSH, remember then to substitute the HTTPS URL, https://github.com/..., with the SSH one, [email protected]:....

  • e.g. Cloning now becomes git clone [email protected]:<your-username>/Scribe-Desktop.git

GitHub also has their documentation on how to Generate a new SSH key 🔑

# Clone your fork of the repo into the current directory.
git clone https://github.com/<your-username>/Scribe-Desktop.git
# Navigate to the newly cloned directory.
cd Scribe-Desktop
# Assign the original repo to a remote called "upstream".
git remote add upstream https://github.com/scribe-org/Scribe-Desktop.git
  • Now, if you run git remote -v you should see two remote repositories named:
    • origin (forked repository)
    • upstream (Scribe-Desktop repository)
  1. Install Rust and Cargo:
  • For Linux and macOS:

Run the following command in your terminal:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Follow the on-screen instructions to complete the installation. You can find more details in the official Rust documentation.

  • For Windows:

Download and run rustup-init.exe. Follow the instructions in the installer. For more details, visit the Rust Windows installation guide.

After installation, you may need to restart your terminal for the changes to take effect. Verify the installation by running:

rustc --version
cargo --version
  1. (Suggested) Install pre-commit and its hooks to check for and correct common errors in commits:
pip install pre-commit
pre-commit install
# pre-commit run --all-files
  1. Run the following to spin up a local copy of the Scribe-Desktop GUI:
cd scribe
cargo build
cargo run --bin scribe
  1. You may need to give your terminal or IDE permission for your keyboard strokes to be read
    • You may also need to restart the application and then run cargo run --bin scribe again

Note

Feel free to contact the team in the Desktop room on Matrix if you're having problems getting your environment setup!

Issues and projects ⇧

The issue tracker for Scribe-Desktop is the preferred channel for bug reports, features requests and submitting pull requests. Scribe also organizes related issues into projects.

Note

Just because an issue is assigned on GitHub doesn't mean that the team isn't interested in your contribution! Feel free to write in the issues and we can potentially reassign it to you.

Be sure to check the -next release- and -priority- labels in the issues for those that are most important, as well as those marked good first issue that are tailored for first time contributors.

Bug reports ⇧

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search to check if the issue has already been reported.

  2. Check if the issue has been fixed by trying to reproduce it using the latest main or development branch in the repository.

  3. Isolate the problem to make sure that the code in the repository is definitely responsible for the issue.

Great Bug Reports tend to have:

  • A quick summary
  • Steps to reproduce
  • What you expected would happen
  • What actually happens
  • Notes (why this might be happening, things tried that didn't work, etc)

To make the above steps easier, the Scribe team asks that contributors report bugs using the bug report template, with these issues further being marked with the bug label.

Again, thank you for your time in reporting issues!

Feature requests ⇧

Feature requests are more than welcome! Please take a moment to find out whether your idea fits with the scope and aims of the project. When making a suggestion, provide as much detail and context as possible, and further make clear the degree to which you would like to contribute in its development.

Pull requests ⇧

Good pull requests - patches, improvements and new features - are the foundation of our community making Scribe-Desktop. They should remain focused in scope and avoid containing unrelated commits. Note that all contributions to this project will be made under the specified license and should follow the coding indentation and style standards (contact us if unsure).

Please ask first before embarking on any significant pull request (implementing features, refactoring code, etc), otherwise you risk spending a lot of time working on something that the developers might not want to merge into the project. With that being said, major additions are very appreciated!

When making a contribution, adhering to the GitHub flow process is the best way to get your work merged:

  1. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  2. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  3. Commit your changes in logical chunks, and please try to adhere to Conventional Commits.

Note

The following are tools and methods to help you write good commit messages ✨

  1. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull --rebase upstream <dev-branch>

  2. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  3. Open a Pull Request with a clear title and description.

Thank you in advance for your contributions!

Data edits ⇧

Note

Please see the Wikidata and Scribe Guide for an overview of Wikidata and how Scribe uses it.

Scribe does not accept direct edits to the grammar JSON files as they are sourced from Wikidata. Edits can be discussed and the Scribe-Data queries will be changed and ran before an update. If there is a problem with one of the files, then the fix should be made on Wikidata and not on Scribe. Feel free to let us know that edits have been made by opening a data issue or contacting us in the issues for Scribe-Data and we'll be happy to integrate them!

Localization ⇧

Being an app that focusses on language learning, localization plays a big part in what Scribe will eventually be. Those interested are more than welcome to join the team at scribe-org/Scribe-i18n where we work on localizing all Scribe applications via Weblate.

Documentation ⇧

Documentation is an invaluable way to contribute to coding projects as it allows others to more easily understand the project structure and contribute. Issues related to documentation are marked with the documentation label.

Design ⇧

Public Figma Designs

Designs for Scribe are done in the public design file in Figma. Those interested in helping with Scribe's design are also welcome to share their ideas using the design improvement template that makes an issue marked with the design label.

All branding elements such as logos, icons, colors and fonts should follow those that are set out in scribe-org/Organization. As the project is fully open source, these elements are also open for discussion. Efforts in making Scribe products professional with a distinct and cohesive identity are much appreciated!