Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add run on repl.it badge to README #140

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add run on repl.it badge to README #140

wants to merge 1 commit into from

Conversation

siva251
Copy link

@siva251 siva251 commented Jul 26, 2020

This pull request adds a badge to the . This will allow users to easily run this repository in their browser, without having to set up an environment. You can learn more about Repl.it here.

Please read the contribution guidelines before filling out this pull request template.

Prerequisites

This section and the instructions in the sections below are only part of this pull request template. Please ensure to delete this whole section, all pre-filled instructions of the sections below and sections you have not filled out before submitting to ensure a clear structure and overview.

Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug fix to help maintainers and the community understand and reproduce the behavior, find related pull requests and to merge it faster.

  • Ensure the pull request has not already been reported by using the GitHub Pull Request search — if it has and the pull request is still open, add a comment to the existing pull request instead of opening this new one. If you find a closed pull request that seems to be similar to this one, include a link to it in the metadata head section of this pull request.
  • Ensure the contribution doesn't belong to any port project.
  • Ensure to adhere to the pull request contribution guidelines, especially the one for tests and documentations.

Metadata Head

The metadata head should be added to the top of the pull request as Markdown text quote containing the [GitHub issue keywords][gh-help-issue-keywords] to link to the related enhancements suggestions (Closes) or bug reports (Fixes). You can add additional details like dependencies to other pull requests and the order it needs to be merged.

Closes ISSUE_ID
Must be merged after/before ISSUE_ID

Description

Describe the changes as in many relevant details as possible. If this is a enhancement suggestion add specific use-cases and explain why this feature or improvement would be useful. If this is a bug fix ensure to provide a before/after comparison by describing the current behavior and the new behavior.

References

Add any other references and links which are relevant for this issue.

This pull request adds a  badge to the . This will allow users to easily run this repository in their browser, without having to set up an environment. You can learn more about Repl.it [here](https://repl.it).
Copy link
Contributor

@arcticicestudio arcticicestudio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @siva251 👋, thanks for your contribution 👍
I guess this has no real benefit since there is not really “nothing to see“ in this repository.
The defined tasks in the package.json will only create the color palettes in different file formats like Sass and “vanilla“ CSS. These tasks are also run in the CI/CD pipeline (currently still stuck at CircleCI that are failing because they dropped support for their API version 1 and I haven't git the time yet to migrate this repository to the awesome GitHub Actions).

Anyway, I guess if anyone wants to check out the code of this repository a simple git clone should be fine or just importing it into a _CodeSandbox (https://codesandbox.io/s/github/arcticicestudio/nord) to not install it locally (or put it into a Docker container).
Explicitly adding a CodeSandbox or REPL.it link/button might make users think that there is actually “visual“ content here instead of leading them to the official port projects. Actually the added npm start run command would fail since there is nothing that could be started.

Thank you for taking the time to contribute, but unfortunately this change would (currently) not fit in this repository. Sorry that I've do reject this PR (marked as your first PR on GitHub), but please don't let that put you off to contribute to other (or this) project(s) 🙏🏼
It's normal that not every PR can be merged for many different reasons. A recommendation from me is that you should open an issue first to present your idea what could be added/changed before actually investing time into writing the code/documentation. I'd really like to recommend the fantastic Open Source Guides that are maintained by the open source community, the GitHub staff and many others. There are a ton of great resources like e.g. how to start to contribute to a open source project 🚀

known-samy

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants