Skip to content

Commit

Permalink
added GitHub configuration and community files
Browse files Browse the repository at this point in the history
  • Loading branch information
norbertschuler committed May 17, 2021
1 parent f2c4d3a commit 7f48292
Show file tree
Hide file tree
Showing 9 changed files with 478 additions and 194 deletions.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Bug Report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
*A clear and concise description of what the bug is.*

**Is it on a Production or Development Build?**

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
*A clear and concise description of what you expected to happen.*

**What actually happens**
*A clear and concise description of what happens instead of the expected behavior.*

**Screenshots**
*If applicable, add screenshots to help explain your problem.*

**Desktop (please complete the following information):**
- OS: [e.g. latest MacOS]
- Browser: [e.g. latest Chrome, Safari]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone]
- OS: [e.g. latest iOS]
- Browser: [e.g. stock browser, Safari]

**Additional context**
*Add any other context about the problem here.*
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest a feature for Planet Pay
title: ''
labels: enhancement
assignees: ''
---

**Describe the feature you'd like to see included in Planet Pay.**
*A clear, detailed description of the feature you're requesting.*

**What are the use cases for this feature?**
*e.g. See list of all trees I have planted, find projects around me etc.*

**Examples of this feature or functionality.**
*If another product has done it well, provide examples here. Or include your concept*

**Feature Checklist**

- [ ] I have searched for existing issues and to the best of my knowledge this is not a duplicate
- [ ] I have included at least one example image if it could be helpful (optional)
- [ ] The request requires change in APIs, Backend, etc (optional)

24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Fixes #

Check this list and then dismiss it:
- **Localization**
- Have you added translation resources?
- Have you localized numbers, dates and other stuff?
- **Validation and error management**
- Is the user input validated?
- Is the API response valided and are error responses properly handled?
- Are errors caught if necessary?
- **Coding style**
- Have you used a specific type for declaring the properties and parameters instead of `any`?
- Have you defined interfaces for new components?
- Have you added a source file not using TypeScript?
- Have you checked if your newly introduced modules or functions are not already existing?
- Is your `React.useEffect` using the right dependencies?
- Check your code if it matches the existing code formatting.

Changes in this pull request:
-
-
-

@
67 changes: 67 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
push:
branches: [ develop, main ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ develop ]
schedule:
- cron: '44 22 * * 6'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
language: [ 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

steps:
- name: Checkout repository
uses: actions/checkout@v2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
20 changes: 20 additions & 0 deletions .github/workflows/eslint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: 'ESLint error report'
on:
pull_request:
branches:
- develop
- main
jobs:
ubuntu-job:
name: 'ESLint on Ubuntu'
runs-on: ubuntu-latest # Can be self-hosted runner also
steps:

- name: 'Checkout the repository'
uses: actions/checkout@v2

- name: 'Install Node Modules'
run: npm install

- name: 'Running ESLint only showing errors'
run: npm run lint:errors
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making 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 both within project spaces and in public spaces
when an individual is representing the project or its community. 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 team at [email protected]. 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

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contributing

When contributing to this repository, please feel free to create a pull request and decribe your changes. You can also first create an issue. We will probably contact you by directly commenting on your issue or inviting you to our Slack channel to discuss your contribution.

Please note we have a [code of conduct](https://github.com/Plant-for-the-Planet-org/pay-with-planet/blob/develop/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

## Pull Request Process

1. Ensure you pull request builds with `npm run dev`
2. Update the [README.md](https://github.com/Plant-for-the-Planet-org/pay-with-planet/blob/develop/README.md) if you change something in the development process.
5. You may merge the Pull Request in once you have the sign-off of another developer, or if you
do not have permission to do that, you may request the reviewer to merge it for you.
Loading

0 comments on commit 7f48292

Please sign in to comment.