Skip to content

Latest commit

 

History

History
245 lines (171 loc) · 9.92 KB

CONTRIBUTING.md

File metadata and controls

245 lines (171 loc) · 9.92 KB

Contributing to Slides

Thank you for contributing to Slides!

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 patches and features.

Contents

Tech Stack ⇧

The following are the current technologies used in Slides:

Frontend

Note

Those new to any frameworks or technologies who want to work on their skills are more than welcome to contribute!

Learning the tech stack ⇧

Slides is very open to contributions from people in the early stages of their coding journey! The following is a select list of documentation pages to help you understand the technologies we use.

Docs for those new to programming

Slides tech docs

Development environment ⇧

  1. First and foremost, please see the suggested IDE setup in the dropdown below to make sure that your editor is ready for development.

Important

Suggested IDE setup

VS Code

Install the following extensions:

  1. Fork the Slides 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]:....

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>/slides.git
# Navigate to the newly cloned directory.
cd slides
# Assign the original repo to a remote called "upstream".
git remote add upstream https://github.com/scribe-org/slides.git
  • Now, if you run git remote -v you should see two remote repositories named:
    • origin (forked repository)
    • upstream (Slides repository)
  1. Install the dependencies for all presentations including making Prettier format slides.md files via the top level package.json and .prettierrc files:
# Based on your package manager:
yarn install
npm install
pnpm install
  1. Build and open your slides of choice by navigating to its directory and executing the run dev command for your package manager:
cd SLIDES_OF_CHOICE

# Based on your package manager:
yarn run dev
npm run dev
pnpm run dev
  1. Once finished you can visit http://localhost:3030 to view the slides. Follow the prompts in your terminal to close them or do other actions.

Issues ⇧

The issue tracker for Slides is the preferred channel for bug reports, features requests and submitting pull requests.

Be sure to check the -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 Slides 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. Feature requests are marked with the feature label in the issues.

Pull requests ⇧

Good pull requests — patches, improvements and new features — are the foundation of our community making Slides. 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. Install pre-commit to ensure that each of your commits is properly checked against our linter and formatters:

    # In the project root:
pre-commit install

Note

pre-commit is Python package that can be installed via pip or any other Python package manager. You can also find it in our requirements.txt file.

pip install pre-commit

Note

If you are having issues with pre-commit and want to send along your changes regardless, you can ignore the pre-commit hooks via the following:

git commit --no-verify -m "COMMIT_MESSAGE"
  1. 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!