diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..05debc8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ +## Checklist + + + +- [ ] I ran `yarn test:unit` locally and it passed without errors. +- [ ] I only edited the `src/assets/data.js` file. + + diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000..914003a --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,17 @@ + +newPRWelcomeComment: > + Thanks so much for opening your first PR here! +firstPRMergeComment: > + Congrats on merging your first pull request here! :tada: How awesome! +newIssueWelcomeComment: > + Thanks for opening this issue, a maintainer will get back to you shortly! +sentimentBotToxicityThreshold: .7 + +sentimentBotReplyComment: > + Please be sure to review the code of conduct and be respectful of other users. cc/ @YasiOnFire +lockThreads: + toxicityThreshold: .7 + numComments: 2 + setTimeInHours: 72 + replyComment: > + This thread is being locked due to exceeding the toxicity minimums. cc/ @YasiOnFire diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 0000000..39f5021 --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,65 @@ +# Configuration for probot-stale - https://github.com/probot/stale + +# Number of days of inactivity before an Issue or Pull Request becomes stale +daysUntilStale: 60 + +# Number of days of inactivity before an Issue or Pull Request with the stale label is closed. +# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale. +daysUntilClose: 7 + +# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled) +# onlyLabels: [] + +# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable +exemptLabels: + - pinned + - security + - '[Status] Maybe Later' + +# Set to true to ignore issues in a project (defaults to false) +exemptProjects: false + +# Set to true to ignore issues in a milestone (defaults to false) +exemptMilestones: false + +# Set to true to ignore issues with an assignee (defaults to false) +exemptAssignees: false + +# Label to use when marking as stale +staleLabel: stale + +# Comment to post when marking as stale. Set to `false` to disable +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. + Please re-open the issue if this issue is still relevant. + Thank you for your contributions. + +# Comment to post when removing the stale label. +# unmarkComment: > +# Your comment here. + +# Comment to post when closing a stale Issue or Pull Request. +# closeComment: > +# Your comment here. + +# Limit the number of actions per hour, from 1-30. Default is 30 +limitPerRun: 30 + +# Limit to only `issues` or `pulls` +# only: issues + +# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls': +pulls: + daysUntilStale: 30 + daysUntilClose: 7 + markComment: > + This pull request has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. + Feel free to open a new pull request to resubmit your contribution. Please make + sure your [fork is synced](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) before opening the pull request. + Thank you for your contributions. + +issues: + exemptLabels: + - confirmed diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a48bab5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,72 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project author at baszczok@yasio.pl. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html diff --git a/README.md b/README.md index 35ada99..ae73924 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,67 @@ [WIP] # CodersRailroad 🚂 +[![Netlify Status](https://api.netlify.com/api/v1/badges/ce52d7e4-bfb2-497c-a46c-096a68712f34/deploy-status)](https://app.netlify.com/sites/coders-railroad/deploys) -This is a simple project made for Hactoberfest 2020. An easy entry to Pull Requests. Inspired by Twolio Open Pixel Art. +This is a simple project made for [Hactoberfest 2020](https://hacktoberfest.digitalocean.com/). An easy entry to Pull Requests. You can add your cart to the HF2020 train by submitting a PR. + +See the train in action: [https://coders-railroad.netlify.app/](https://coders-railroad.netlify.app/) + +## How to contribute? + +1. Fork repo +2. Clone your fork +3. Run `yarn` +4. Add your cart to `src/assets/data.js` and run `yarn serve` to see your cart +5. Run `yarn test:unit` +6. Commit, push, create pull request + +### Cart config example: + +```javascript +{ + name: "YasiOnFire", // your Github name + text: "Yasio", // your message (max 18 chars) + cart: 1 // one of four avaiable carts, see below +} +``` + +### Avaiable carts: +``` +__.oO.oOo.oOo.oOo.__ +| | +| #0 | +"OO--------------OO"= + +_____________________ +| | +| #1 | +"OO---------------OO"= + ________________ + | | + | | +_| #2 |_ +"OO--------------OO"= + _________ + ____||_______||____ +| | +|_ #3 _| +"OO---------------OO"= +``` + +### Rules + +* only `data.js` may be edited +* must pass tests +* only one cart per github user +* text may contain only letters, digits and should be maximum of 18 chars +* must comply with the code of conduct + +## Requirements +* node (preferably >=14) +* yarn + +--- + +Made with [Vue](https://github.com/vuejs/vue) 💚. +Inspired by [Twilio Open Pixel Art](https://open-pixel-art.com/) project. diff --git a/public/favicon.ico b/public/favicon.ico index df36fcf..7757d8c 100644 Binary files a/public/favicon.ico and b/public/favicon.ico differ diff --git a/public/index.html b/public/index.html index 5fffe07..62ab124 100644 --- a/public/index.html +++ b/public/index.html @@ -6,7 +6,21 @@ - 🚂 Coders Railroad + + + + + + + + + + + + + + + Coders Railroad 🚂