-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
π 185 comply with community standards (#229)
* Added contributing.md * Added PR template * Updated feature template * Updated bug template * Removed links and a tags
- Loading branch information
1 parent
08c35b4
commit 075c26f
Showing
4 changed files
with
91 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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!** | ||
|
||
--- |