Skip to content

Commit

Permalink
Merge pull request #86 from IntersectMBO/docs-update-boilerplate
Browse files Browse the repository at this point in the history
  • Loading branch information
vpaunovic authored Jul 19, 2024
2 parents 905a8fc + 808d9b8 commit 3bbfded
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 71 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
blank_issues_enabled: true
contact_links:
- name: Contributing guidelines
url: https://github.com/IntersectMBO/xxxx/blob/master/CONTRIBUTING.md
url: https://github.com/IntersectMBO/govtool-proposal-discussion/blob/master/CONTRIBUTING.md
about: Some rules & processes we honor.

- name: Feature ideas
url: https://github.com/IntersectMBO/xxxx/discussions/categories/ideas
url: https://github.com/IntersectMBO/govtool-proposal-discussion/discussions/categories/ideas
about: Maybe someone else had the same or a similar idea already?

- name: All issues
url: https://github.com/IntersectMBO/xxxx/issues
url: https://github.com/IntersectMBO/govtool-proposal-discussion/issues
about: Check whether your issue is not already covered here.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_idea.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
value: |
**Thank you for contributing to our project!** :green_heart:
Instead of opening this issue, consider [starting a new idea discussion](https://github.com/IntersectMBO/xxxx/discussions/new?category=ideas).
Instead of opening this issue, consider [starting a new idea discussion](https://github.com/IntersectMBO/govtool-proposal-discussion/discussions/new?category=ideas).
That way, we can discuss & refine your idea together, before we adopt it as a feature into the roadmap.
- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

## Checklist

- [related issue](https://github.com/IntersectMBO/xxxx/issues/)
- [related issue](https://github.com/IntersectMBO/govtool-proposal-discussion/issues/)
- [ ] My changes generate no new warnings
- [ ] My code follows the [style guidelines](https://github.com/IntersectMBO/xxxx/tree/main/docs/style-guides) of this project
- [ ] My code follows the [style guidelines](https://github.com/IntersectMBO/govtool-proposal-discussion/tree/main/docs/style-guides) of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added tests that prove my fix is effective or that my feature works
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# xxxx Changelog
# GovTool Proposal Discussion Backend Changelog

All notable changes to this project will be documented in this file.

Expand Down
2 changes: 1 addition & 1 deletion CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[XXXX@intersectmbo.org](XXXX@intersectmbo.org).
[oso@intersectmbo.org](oso@intersectmbo.org).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
9 changes: 1 addition & 8 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# xxxx Project Codeowners
# GovTool Proposal Discussion Backend Project Codeowners

# These owners will be the default owners for everything in the repository.

# Frontend assets templates

# Backend

# DevOps

# Testing
57 changes: 5 additions & 52 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Contributing to the `xxxx` project
# Contributing to the `GovTool Proposal Discussion Backend` project

Thanks for considering contributing and helping us on creating xxxx! 😎
Thanks for considering contributing and helping us on creating GovTool Proposal Discussion Backend! 😎

The best way to contribute right now is to try things out and provide feedback, but we also accept contributions to the documentation and the obviously to the code itself.

This document contains guidelines to help you get started and how to make sure your contribution gets accepted, making you our newest xxxx contributor!
This document contains guidelines to help you get started and how to make sure your contribution gets accepted, making you our newest GovTool Proposal Discussion Backend contributor!

## Table of Contents

- [Contributing to the `xxxx` project](#contributing-to-the-xxxx-project)
- [Contributing to the `GovTool Proposal Discussion Backend` project](#contributing-to-the-govtool-proposal-discussion-backend-project)
- [Table of Contents](#table-of-contents)
- [Code of Conduct](#code-of-conduct)
- [Ask for Help](#ask-for-help)
Expand All @@ -30,12 +30,6 @@ This document contains guidelines to help you get started and how to make sure y
- [React](#react)
- [CSS in Javascript](#css-in-javascript)
- [CSS / SASS](#css--sass)
- [Haskell](#haskell)
- [Development Processes](#development-processes)
- [Developer workflow](#developer-workflow)
- [QA Workflow](#qa-workflow)
- [PO Workflow](#po-workflow)
- [Tech Lead Workflow](#tech-lead-workflow)

## Code of Conduct

Expand Down Expand Up @@ -77,7 +71,7 @@ Please complete the following steps in advance to help us fix any potential bug

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Open an [Issue](https://github.com/IntersectMBO/xxxx/issues/new).
- Open an [Issue](https://github.com/IntersectMBO/GovTool Proposal Discussion Backend/issues/new).
(Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible.
Expand Down Expand Up @@ -196,44 +190,3 @@ Please see [CSS in Javascript Style Guide](./docs/style-guides/css-in-js/).
#### CSS / SASS

Please see [CSS / SASS Style Guide](./docs/style-guides/css-sass/).

#### Haskell

TODO

## Development Processes

### Developer workflow

<!-- CHANGE TO HOW THE PROJECT NEEDS -->

- Choose ticket/issue to work on from the project, move ticket from `todo` to `in progress`.
- Create [well named](#branch-naming) branch from `develop` add changes, then make a pull request back to the `develop` branch.
- If the changes are not ready for review then feel free to create a draft PR, and link this to the ticket/issue.
- Developers should review each other's pull requests, and should be requested via [CODEOWNERS](./CODEOWNERS).
- Unit tests are run on each pull request to `develop`.
- Once tests pass and peer review is done the branch can be merged into `develop` by author and then deployed to the dev environment (manually for now).
- The ticket status can then be moved ticket to `in QA` making sure that the PR/branch has been added to the ticket/issue as a comment.

### QA Workflow

- Choose ticket from `in QA`.
- Merge in the ticket's changes from `develop` branch into `test` branch.
- Deploy to test environment (manually for now).
- The QA tests the deployed test environment against the ticket.
- If QA agrees that the code is good, they can make a PR from `test` branch to `staging` branch where end-to-end and performance tests are run.
- If tests pass, then QA or tech lead can merge and deploy to staging environment (manually for now).
- Moving ticket to `staging` status this ready for PO check.

### PO Workflow

- Choose ticket from `staging` status.
- Compare the deployment on staging environment to the contents of the ticket.
- If the deployment has been satisfied via the staging environment, PO comments on the ticket to be included in next release.

### Tech Lead Workflow

- Bundle the staging status tickets together into a new tag.
- Merge `staging` branch into the `main` branch.
- Deploy tagged build to `beta` environment.
- Move tickets from staging status to done status.
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Reporting a Vulnerability

Please report (suspected) security vulnerabilities to [XXXX@intersectmbo.org](XXXX@intersectmbo.org).
Please report (suspected) security vulnerabilities to [security@intersectmbo.org](security@intersectmbo.org).
You will receive a response from us within 48 hours.
If the issue is confirmed, we will release a patch as soon as possible.

Expand Down
4 changes: 2 additions & 2 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Ask for help

Should you have any questions or need some help in getting set up, you can use these communication channels to reach the xxxx team and get answers in a way where others can benefit from it as well:
Should you have any questions or need some help in getting set up, you can use these communication channels to reach the GovTool Proposal Discussion Backend team and get answers in a way where others can benefit from it as well:

- Github [Discussions](https://github.com/IntersectMBO/xxxx)
- Github [Discussions](https://github.com/IntersectMBO/govtool-proposal-dicussion)

# Reporting a Vulnerability

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 3bbfded

Please sign in to comment.