Skip to content

Commit

Permalink
πŸ“ 185 comply with community standards (#229)
Browse files Browse the repository at this point in the history
* Added contributing.md

* Added PR template

* Updated feature template

* Updated bug template

* Removed links and a tags
  • Loading branch information
danielmackay authored Dec 21, 2023
1 parent 08c35b4 commit 075c26f
Show file tree
Hide file tree
Showing 4 changed files with 91 additions and 10 deletions.
21 changes: 15 additions & 6 deletions .github/ISSUE_TEMPLATE/0-feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,27 @@ assignees: ''
<!-- Next to Cc:, @ mention users who should be in the loop -->
Cc:
<!-- add intended user next to **Hi** -->
Hi
Hi {{ USER }}

### Pain
<!-- Explain the pain you are experiencing -->
Explain the pain you are experiencing. This is **WHY** this must be done.

### Suggested Solution
<!-- Describe the solution you'd like -->

### Acceptance Criteria
Acceptance Criteria defines the requirements that must be met for the story to be completed. This is **WHAT** must be done.

See https://www.ssw.com.au/rules/acceptance-criteria.

1. {{ AC 1 }}

### Tasks
<!--Add GitHub tasks-->
- [ ] ...
- [ ] ...
Tasks help developers to track small bits of work needed to meet the ACs. This is **HOW** the work will be done.

```[tasklist]
- [ ] {{ TASK 1 }}
```

### More Information
<!-- Add any other context here. -->
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/1-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ assignees: ''
<!-- Next to Cc:, @ mention users who should be in the loop -->
Cc:
<!-- add intended user next to **Hi** -->
Hi
Hi {{ USER }}

### Describe the Bug
<!-- A clear and concise description of what the bug is. -->
Expand All @@ -34,9 +34,9 @@ Steps to reproduce the behavior:
<!-- Add any other context about the problem here. -->

### Environment
- Device: [e.g. iPhone 12]
- Browser: [e.g. chrome, safari]
- OS: [e.g. iOS]
- Device: [e.g. iPhone 12]
- Browser: [e.g. chrome, safari]
- OS: [e.g. iOS]

### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->
Expand Down
20 changes: 20 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
> 1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc)
✏️

> 2. What was changed?
✏️

> 3. Did you do pair or mob programming?
✏️
<!-- E.g. I worked with @gordonbeeming and @sethdailyssw -->

<!--
Check out the relevant rules
- https://www.ssw.com.au/rules/rules-to-better-pull-requests
- https://www.ssw.com.au/rules/write-a-good-pull-request
- https://www.ssw.com.au/rules/over-the-shoulder-prs
- https://www.ssw.com.au/rules/do-you-use-co-creation-patterns
-->
52 changes: 52 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 🀝 Contributing to the SSW.CleanArchitecture Template

Thank you for exhibiting interest in contributing to the SSW.CleanArchitecture Template. The team is delighted to welcome you onboard to our exciting and growing project. Any contribution or value added go a long way to enhance the project!

In the next few steps, you will be able to see a glimpse of ways you can contribute to the SSW.CleanArchitecture Template.

## ❔ Questions

Questions can be asked via [GitHub Discussions](https://github.com/SSWConsulting/SSW.CleanArchitecture/discussions).

## πŸ› Fix a Bug

If you find any bug, you can help the community by [submitting an issue](https://github.com/SSWConsulting/SSW.CleanArchitecture/issues/new?assignees=&labels=Type%3A+Bug&projects=&template=1-bug.md&title=%F0%9F%90%9B+). Once the issue is filed, feel free to start working on the PR and submit a PR.

## ✨ Add New Feature

* To contribute a new feature, fill out the [Feature Request Template](https://github.com/SSWConsulting/SSW.CleanArchitecture/issues/new?assignees=&labels=Type%3A+Feature&projects=&template=0-feature.md&title=%E2%9C%A8) and provide detailed information to express the proposal.
* Once the Feature Request is submitted, it will be open for discussion.
* If it gets approved by the team, proceed to submit a PR of the proposed Feature.
* If the PR contains an error-free code and the reviewer signs off, the PR will be merged.

## πŸ“ Add or Improve Documentation

If you find any errors in the documentation, you can create a [Documentation Issue](https://github.com/SSWConsulting/SSW.CleanArchitecture/issues/new?assignees=&labels=Type%3A+Documentation&projects=&template=2-docs.md&title=%F0%9F%93%9D). Once the issue is filed, feel free to start working on the PR and submit a PR.

## πŸ‘€ Create, Submit or Review Pull Request

Anyone can create a Pull Request by forking the repo. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).

Once you fork the repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main repo.

Ensure your pull request adheres to the following guidelines:

- The PR template is completed and includes
- The reason for the change
- What was changed
- Did you work on this with anyone else
- All tests should pass
- No warnings should be introduced
- Any signification changes should be documented via an ADR

# Code of Conduct

Please note that this project is released with a
[Contributor Code of Conduct](code-of-conduct.md). By participating in this
project you agree to abide by its terms.

## πŸ’™ Thank You

**Thank you so much for contributing to this project!**

---

0 comments on commit 075c26f

Please sign in to comment.