Skip to content

Commit

Permalink
2024 update
Browse files Browse the repository at this point in the history
  • Loading branch information
hbulens committed Apr 10, 2024
1 parent 9a1f408 commit c285fac
Show file tree
Hide file tree
Showing 96 changed files with 7,238 additions and 4,694 deletions.
154 changes: 14 additions & 140 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,149 +1,23 @@
# Contributing
## Contributing

Here are the guidelines we'd like you to follow:
Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**.

- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Semantic Versioning](#semantic-versioning)
- [Questions, Bugs, Features](#questions-bugs-features)
- [Questions](#questions)
- [Bugs](#bugs)
- [Features](#features)
- [Issue Submission Guidelines](#issue-submission-guidelines)
- [Pull request Submission Guidelines](#pull-request-submission-guidelines)
- [After your pull request is merged](#after-your-pull-request-is-merged)

Make sure to comply with the [code of conduct](CODE_OF_CONDUCT.md).
### Personal Support
If you have personal support or setup questions the best place to ask those are [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js).

## Code of Conduct

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
### Bug Reports
When reporting a bug make sure to include information about which browser and operating system you are on as well as the necessary steps to reproduce the issue. If possible please include a link to a sample presentation where the bug can be tested.

Dime has adopted the [Contributor Covenant](./CODE_OF_CONDUCT.md) as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

## Semantic Versioning
### Pull Requests
- Should follow the coding style of the file you work in, most importantly:
- Tabs to indent
- Single-quoted strings
- Should be made towards the **dev branch**
- Should be submitted from a feature/topic branch (not your master)

Dime follows semantic versioning. We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.

## Questions, Bugs, Features

### Questions

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on dedicated support platforms, the best being [Stack Overflow][stackoverflow].

### Bugs

If you find a bug in the source code, you can help us by submitting an issue to our
GitHub repository. Even better, you can submit a pull request with a fix.

Please see the [submission guidelines](#issue-submission-guidelines) below.

### Features

You can request a new feature by submitting an issue to our GitHub repository.

If you would like to implement a new feature then consider what kind of change it is:

* **Major Changes** that you wish to contribute to the project should be discussed first in an issue that clearly outlines the changes and benefits of the feature.
* **Small Changes** can directly be crafted and submitted to the GitHub repository
as a pull request. See the section about [pull request submission guidelines](#submit-pr).

## Issue Submission Guidelines

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. The new issue form contains a number of prompts that you should fill out to
make it easier to understand and categorize the issue.

In general, providing the following information will increase the chances of your issue being dealt with quickly:

- **Overview of the issue**: if an error is being thrown a non-minified stack trace helps
- **Motivation for or use case**: explain why this is a bug for you
- **Version(s)**: is it a regression?
- **Browsers and/or operating system**:is this a problem with all browsers or only specific ones?
- **Reproduce the error**: provide a live example or an unambiguous set of steps.
- **Related issues**: has a similar issue been reported before?
- **Suggest a Fix**: if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

## Pull request Submission Guidelines

Before you submit your pull request consider the following guidelines:

- Search GitHub for an open or closed pull request that relates to your submission. You don't want to duplicate effort.
- Create the development environment
- Make your changes in a new git branch:

```shell
git checkout -b my-fix-branch master
```

- Create your patch commit, **including appropriate test cases**.
- Follow the coding rules.
- If the changes affect public APIs, change or add relevant documentation.
- Run the test suites, and ensure that all tests pass.
- Commit your changes using a descriptive commit message that follows the commit message convention.

```shell
git commit -a
```

Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

- Before creating the pull request, package and run all tests a last time.
- Push your branch to GitHub:

```shell
git push origin my-fix-branch
```

- In GitHub, send a pull request to the master branch.

- If you find that the continuous integration tests have failed, look into the logs to find out if your changes caused test failures, the commit message was malformed etc. If you find that the tests failed or times out for unrelated reasons, you can ping a team member so that the build can be restarted.

- If we suggest changes, then:

- Make the required updates.
- Re-run the test suite to ensure tests are still passing.
- Commit your changes to your branch (e.g. `my-fix-branch`).
- Push the changes to your GitHub repository (this will update your pull request).

You can also amend the initial commits and force push them to the branch.

```shell
git rebase master -i
git push origin my-fix-branch -f
```

This is generally easier to follow, but separate commits are useful if the pull request contains iterations that might be interesting to see side-by-side.

That's it! Thank you for your contribution!
### After your pull request is merged
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```shell
git push origin --delete my-fix-branch
```
- Check out the master branch:
```shell
git checkout master -f
```
- Delete the local branch:
```shell
git branch -D my-fix-branch
```
- Update your master with the latest upstream version:
```shell
git pull --ff upstream master
```
[stackoverflow]: http://stackoverflow.com
### Plugins
Please do not submit plugins as pull requests. They should be maintained in their own separate repository. More information here: https://github.com/hakimel/reveal.js/wiki/Plugin-Guidelines
12 changes: 5 additions & 7 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
MIT License

Copyright (c) 2021 Dime Software
Copyright (C) 2020 Hakim El Hattab, http://hakim.se, and reveal.js contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -9,13 +7,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="./assets/logo.png" alt="Dime.Scheduler logo" height="60">
<img src="https://cdn.dimescheduler.com/dime-scheduler/v2/logo.svg" alt="Dime.Scheduler logo" height="100">
</p>

<div align="center">
Expand Down
56 changes: 56 additions & 0 deletions assets/azzure.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/bg.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c285fac

Please sign in to comment.