diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 49432a15bfb..a02852f82cd 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ -**Tip: Use [SSW Rule Writer GPT](https://chat.openai.com/g/g-cOvrRzEnU-ssw-rules-writer) for help with writing rules 🤖** + > > 1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc) diff --git a/categories/company-operations/rules-to-better-accounting.md b/categories/company-operations/rules-to-better-accounting.md index d4012d7dc42..94b4ecc415f 100644 --- a/categories/company-operations/rules-to-better-accounting.md +++ b/categories/company-operations/rules-to-better-accounting.md @@ -32,8 +32,5 @@ index: - do-you-calculate-payroll-tax-correctly - do-you-check-your-customers-organisation-age-for-prepaid - do-you-treat-freebies-as-real-customers -- show-long-service-leave-on-your-payslip -- show-certification-award - --- diff --git a/categories/company-operations/rules-to-better-flights.md b/categories/company-operations/rules-to-better-flights.md index 3b2ad603724..6d30f33f7bf 100644 --- a/categories/company-operations/rules-to-better-flights.md +++ b/categories/company-operations/rules-to-better-flights.md @@ -16,7 +16,6 @@ index: - do-you-keep-your-finance-manager-in-the-loop - use-qantas-bid-now-upgrades - do-you-know-the-best-online-accommodation-websites - - do-you-make-business-travel-easier - do-you-know-how-to-get-the-most-out-of-your-credit-card - do-you-take-advantage-of-business-rewards-programs - missing-flight-invoices diff --git a/rules/allocate-expenses-per-office/rule.md b/rules/allocate-expenses-per-office/rule.md index 79340aa8ab1..7ee50705479 100644 --- a/rules/allocate-expenses-per-office/rule.md +++ b/rules/allocate-expenses-per-office/rule.md @@ -5,25 +5,25 @@ uri: allocate-expenses-per-office authors: - title: Jimmy Chen url: https://www.ssw.com.au/people/jimmy-chen -related: - +related: [] redirects: - do-you-know-how-to-allocate-expense-per-office created: 2024-01-25T00:00:00.000Z guid: 596829da-9013-402d-b8f7-c34a6d42f411 +archivedreason: null --- When a company has multiple offices in different locations, it is important to allocate expenses to each office accurately to ensure that the financial reports reflect the true costs of running the business in each location. Proper expense allocation can also help identify areas of inefficiency and improve cost management. -However, allocating expenses to offices in different locations can be challenging, especially when the expenses are shared among different offices or are difficult to track. +However, allocating expenses to offices in different locations can be challenging, especially when the expenses are shared among different offices or are difficult to track. It requires a systematic approach and a set of guidelines to ensure that expenses are allocated fairly and accurately. ![](Allocate-expense-1.png) -### Direct allocation of expenses +### Direct allocation of expenses -If an expense is attributable to a specific office, it should be allocated directly to that office. +If an expense is attributable to a specific office, it should be allocated directly to that office. This includes expenses such as travel expenses incurred by an employee visiting a specific office or recruitment costs for a particular job opening in a specific office. E.g. If there is a recruitment ad for an open position in Melbourne with a cost of $1,000, it should be allocated to the Melbourne office. @@ -33,14 +33,14 @@ The office chosen should genuinely reflect the beneficiary. * If Bob travels from Sydney to Brisbane to give a speech at a conference held by the Brisbane office, the cost should be allocated to Brisbane * If Bob travels from Sydney to Melbourne for training, then the cost is allocated to Sydney -Automated tools, like accounting software, should be used to streamline the allocation process and reduce the risk of errors. +Automated tools, like accounting software, should be used to streamline the allocation process and reduce the risk of errors. Accounting software, such as Xero, provides the option to include an office for transactions; however, some overhead costs need to be manually allocated based on a certain rate. ![Figure: Office can be assigned on each transaction in Xero](Allocate-expense-2.jpg) ### Allocation of shared expenses and unassigned expenses -If an expense is shared among multiple offices and cannot be directly attributed to a specific office, an administrative rate should be used to allocate the cost across all offices. +If an expense is shared among multiple offices and cannot be directly attributed to a specific office, an administrative rate should be used to allocate the cost across all offices. The method for calculating the administrative rate should be clearly defined in the company rules. Examples of administrative rate calculation methods include the cost of sales or headcount. E.g., if there is a recruitment ad for a position advertised for any office, the cost is not directly allocated to a specific office but is instead allocated by an end-of-month adjustment. @@ -55,8 +55,8 @@ Expenses from the company level can be allocated to each office based on the adm ![Figure: Good example - Software expenses from the company level would be assigned to different offices based on the admin rate](keep-yourself-connected-3.png) ::: -### Review and Communication +### Review and Communication -The allocation process should undergo a review by someone with accounting expertise to ensure the accuracy and consistency of the allocation results. +The allocation process should undergo a review by someone with accounting expertise to ensure the accuracy and consistency of the allocation results. -The company rules governing the allocation process should be effectively communicated to all relevant parties. +The company rules governing the allocation process should be effectively communicated to all relevant parties. diff --git a/rules/angular-separate-component-concerns/rule.md b/rules/angular-separate-component-concerns/rule.md index 6b2da550a5d..609777a11ed 100644 --- a/rules/angular-separate-component-concerns/rule.md +++ b/rules/angular-separate-component-concerns/rule.md @@ -10,6 +10,7 @@ authors: related: - when-to-use-state-management-in-angular - isolate-your-logic-and-remove-dependencies-on-instances-of-objects +archivedreason: null --- One common mistake in writing a front-end component is trying to fit everything in a single component. This can easily lead to unmaintainable code in the long run, especially for complex components. @@ -21,6 +22,7 @@ One common mistake in writing a front-end component is trying to fit everything In simple components, having many logics (e.g. API calls and binding to the form) written to the component itself sometimes works OK, especially if the aim is to reduce the file footprint. However, doing this to larger-sized components can make maintaining the code challenging. The last thing developers want to do is debug a component with 1000+ lines of code with intermingling logic. Pros and cons of combining all logic into a single component: + * 🟢 Less file footprint * 🟢 Easier to write * 🟢 Less problem with reactivity @@ -29,6 +31,7 @@ Pros and cons of combining all logic into a single component: * ❌ Adding more features to this component can be challenging Consider splitting your component's logic when: + * The file has reached 100+ lines of code * The component has two or more sources of data (e.g. route params and API) * UI has many fields that need to be populated from a data source diff --git a/rules/bicep-user-defined-data-types/rule.md b/rules/bicep-user-defined-data-types/rule.md index c11e9d31abf..3a69d658bed 100644 --- a/rules/bicep-user-defined-data-types/rule.md +++ b/rules/bicep-user-defined-data-types/rule.md @@ -1,15 +1,15 @@ --- type: rule -archivedreason: title: Bicep - Do you use User-defined Data Types? guid: 2a3ba816-ba40-4cfe-8193-7e151e038ac5 uri: bicep-user-defined-data-types created: 2024-03-19T19:19:19.1919191Z authors: -- title: Rick Su - url: https://ssw.com.au/people/rick-su + - title: Rick Su + url: https://ssw.com.au/people/rick-su related: [] redirects: [] +archivedreason: null --- diff --git a/rules/brainstorming-idea-champion/rule.md b/rules/brainstorming-idea-champion/rule.md index 0fdb4e12ef7..dee8224d577 100644 --- a/rules/brainstorming-idea-champion/rule.md +++ b/rules/brainstorming-idea-champion/rule.md @@ -14,6 +14,7 @@ related: - do-you-know-how-to-use-tags-for-github-issues created: 2024-04-02T13:42:55.753Z guid: 0034f3e2-a3b5-4527-8d3d-45b27f2e4a1f +archivedreason: null --- During a [Brainstorming Day](/use-the-brains-of-your-company), many great ideas are generated, discussed, and refined. But what happens to these ideas once the day is over? Without a dedicated individual to drive an idea forward, it risks being forgotten or losing momentum. This is where the "Idea Champion" comes in. @@ -38,7 +39,7 @@ During a [Brainstorming Day](/use-the-brains-of-your-company), many great ideas The Idea Champion's role is over when either: -✅ There is a Scrum Team working on the project +✅ There is a Scrum Team working on the project or ❌ Approval isn't reached and the idea is parked (this is a perfectly acceptable outcome - it can always be revisited in a future Brainstorming Day) diff --git a/rules/business-cards-branding/rule.md b/rules/business-cards-branding/rule.md index 6328aaf2781..c631b7585b7 100644 --- a/rules/business-cards-branding/rule.md +++ b/rules/business-cards-branding/rule.md @@ -77,7 +77,5 @@ Here are the instructions for adding a digital business card to your phone walle ![Figure: OK example: If you are going to have Paper Business cards, make sure they POP!](ssw-businesscards.png) ::: good - ![Figure: Good Example - Digital Business Cards such as HiHello are awesome!](dsdsvcsd.png) - ::: diff --git a/rules/communicate-your-product-status/rule.md b/rules/communicate-your-product-status/rule.md index 3d5e1f509b6..eaaa9f9ee13 100644 --- a/rules/communicate-your-product-status/rule.md +++ b/rules/communicate-your-product-status/rule.md @@ -1,15 +1,15 @@ --- type: rule -archivedreason: title: Communication - Do you know how to communicate Product Progress? uri: communicate-your-product-status +guid: b396caf5-9bfb-4607-bc69-7dc13700b3cc created: 2024-03-25T10:39:38.0000000Z authors: -- title: Nick Curran - url: https://ssw.com.au/people/nick-curran + - title: Nick Curran + url: https://ssw.com.au/people/nick-curran related: -- send-sprint-forecast-and-sprint-review-retro-emails-to-the-client -guid: b396caf5-9bfb-4607-bc69-7dc13700b3cc + - send-sprint-forecast-and-sprint-review-retro-emails-to-the-client +archivedreason: null --- As a Product Owner, you are representing the product's stakeholders on the Scrum Team. You will be a representative of the Product to other people in your business, such as your manager or director. You will often be asked the question "How is your Product going?" @@ -23,11 +23,13 @@ Keep stakeholders informed of progress and enthused about your project using mon To prepare for meetings and maximise the chances of success for your project, ensure you have answers to the following questions: 1. **Value - What features have been delivered recently?** Celebrate your successes and demonstrate how your product is adding value to stakeholders. Examples could include: + * A new login screen with better accessibility for visually impaired users * Support for a new business process * A shortened user registration process 2. **Development - How has the Roadmap progressed?** A PBI is a small chunk of work conducted to progress a larger aim. Explain how the completion of these PBIs contributed to achieving the aim of the Product Roadmap. For example: + * Adding Mandarin translations for an Angular component as part of an internationalization feature * Adding payment processing as part of a new subscription feature @@ -38,27 +40,33 @@ To prepare for meetings and maximise the chances of success for your project, en ![Figure: Microsoft Viva Goals can link with Azure DevOps to graphically display the progress of Roadmap items](viva-goals-roadmap.png) 3. **Development - What delays or blockers have been encountered while writing the software?** [Software development is painful and costly](/do-you-manage-clients-expectations/). Explain the difficulties that the project has encountered, and detail your plan to overcome those difficulties. For example: + * The upgrade between Angular versions was delayed as the team's Frontend expert has been sick. A new expert has been brought in to complete the work * The new customer registration process was taking longer than expected to implement. The intention is to make it simpler with fewer screens 4. **Operations - How do the product's metrics compare historically?** If you have responsibility for the operation of your product, you need to be tracking metrics such as the number of users accessing the system or how many hours they are spending on your site. Provide graphs to demonstrate trends. For example: + * Have a graph demonstrating how the user count has changed over the course of the last 2 calendar years ![Figure: A graph helps demonstrate trends affecting the Product](user-metrics.png) 5. **Operations - What issues have been seen in Production?** [All errors should be logged](/do-you-log-every-error/), so you should be able to list any significant errors that stakeholders and users have experienced and the plan to prevent those errors in future. You should also be actively monitoring for performance issues. All such issues should have plans for investigation or rectification. For example: + * The frontend has experienced an increase in exceptions when adding new users to the system. This was been tracked to a bug in how data is being serialized from the backend, and was fixed last Sprint * Since upgrading the database server version, a significance increase of 2 seconds in server response time has been seen. System Administrators are investigating 6. **Planning - What decisions have been made regarding the project?** As Product Owner, you will be approving changes to the behaviour of the product and many of these changes will be in development. Explain the decisions that you've made and their rationale. Try to catch misalignments in stakeholder views before your decisions are coded. For example: + * I have modified the permissions model for the website to allow contributing users access to unpublished articles, as they often request input from each other * I approved the mock-ups for the website redesign, as they were cleaner and easier to understand than the current website pages 7. **Planning - How should the Roadmap be changed to remain relevant?** Circumstances and priorities change - work with your stakeholders to ensure that your product fulfils their requirements while making efficient use of development resources. In extreme cases, the Product Goal itself may need to be revised. For example: + * Users have had significant difficulty writing new articles, as the editing control does not make it easy to link to other articles. Therefore, work should be prioritized to improve how inter-article links are created * There has been a significant increase in users, so work needs to be prioritized to improve the throughput of transactions 8. **Resources - do you have everything you need to complete the updated Product Roadmap?** Ensure that you have agreements for funding, personnel or services, or everyone will be unhappy when the Roadmap is inevitably not delivered. For example: + * To implement the article search functionality, approval is required for an increase in funding to cover the Azure Search Service instance * To implement the Artificial Intelligence co-writing feature, approval is required to apply for and pay for the Azure OpenAI Service diff --git a/rules/desired-features-of-structuring-large-builds-in-vsnet/rule.md b/rules/desired-features-of-structuring-large-builds-in-vsnet/rule.md index e3ac670a0d3..8424ea4a004 100644 --- a/rules/desired-features-of-structuring-large-builds-in-vsnet/rule.md +++ b/rules/desired-features-of-structuring-large-builds-in-vsnet/rule.md @@ -7,23 +7,25 @@ authors: url: https://ssw.com.au/people/adam-cogan/ created: 2014-03-14T05:53:00.000Z guid: e576f1eb-076a-4371-a505-12cf0d4c38fb +related: [] +redirects: [] +archivedreason: null --- The desired features of structuring large Builds in VS.NET: - + 1. **Scalable** - The project should allow continuous additions to the structure - - Developers should be able to keep adding to the structure + * Developers should be able to keep adding to the structure 2. **Multiple Versions** - The project should support multiple product releases - - The structure should be able to allow developers to work on the next release while there is still work in progress for a previous release of another section of the project - - Developers can work side by side with different versions in parallel (i.e. at the same time) + * The structure should be able to allow developers to work on the next release while there is still work in progress for a previous release of another section of the project + * Developers can work side by side with different versions in parallel (i.e. at the same time) 3. **Efficient** - The build should be as quick as possible 4. **Reliability** - Builds should be reproducible on any machine and reliable 5. **Switchable** - The project should be able to switch between debug release and other versions - - The project should be able to activate without debug. - - A config should be made for a demo build. - - It should support a full release. - + * The project should be able to activate without debug. + * A config should be made for a demo build. + * It should support a full release diff --git a/rules/disagreeing-with-powerful-stakeholders/rule.md b/rules/disagreeing-with-powerful-stakeholders/rule.md index c4c451b083f..02d6882e98d 100644 --- a/rules/disagreeing-with-powerful-stakeholders/rule.md +++ b/rules/disagreeing-with-powerful-stakeholders/rule.md @@ -14,6 +14,7 @@ related: - for-the-record created: 2024-03-21T04:59:07.597Z guid: 2848c2b5-28cc-475f-ab24-0983f8d38b5a +archivedreason: null --- Disagreeing with powerful stakeholders can have a huge impact. It's always good to speak up, but a poorly worded disagreement can result in misalignment or frustration. That's why it's crucial to frame your messages in a way that ensures ideas are expressed effectively. @@ -102,7 +103,7 @@ Bad example - The Developer didn't express that it was their opinion. ::: :::greybox -**Product Owner**: \[See above] +**Product Owner**: [See above] **Developer**: In my opinion, it's better if we upgrade to .NET 8 this Sprint because it will help fix users' performance issues. ::: diff --git a/rules/do-you-add-end-screen-to-your-youtube-videos/rule.md b/rules/do-you-add-end-screen-to-your-youtube-videos/rule.md index ac53d569008..afd933b99ed 100644 --- a/rules/do-you-add-end-screen-to-your-youtube-videos/rule.md +++ b/rules/do-you-add-end-screen-to-your-youtube-videos/rule.md @@ -1,24 +1,24 @@ --- type: rule -archivedreason: title: Do you add end screen to your YouTube videos? guid: ddc1af04-cd76-4096-95aa-12626d12491f uri: do-you-add-end-screen-to-your-youtube-videos created: 2018-07-27T00:10:17.0000000Z authors: -- title: Florent Dezettre - url: https://ssw.com.au/people/florent-dezettre + - title: Florent Dezettre + url: https://ssw.com.au/people/florent-dezettre related: -- personalized-thumbnail -- sort-videos-into-playlists -- untapped-keywords -- videos-youtube-friendly -- optimize-videos-for-youtube -- keep-audience-happy -- youtube-cards -- do-you-add-time-links-on-your-youtube-videos -- do-you-follow-image-standard-sizes-on-social-media + - personalized-thumbnail + - sort-videos-into-playlists + - untapped-keywords + - videos-youtube-friendly + - optimize-videos-for-youtube + - keep-audience-happy + - youtube-cards + - do-you-add-time-links-on-your-youtube-videos + - do-you-follow-image-standard-sizes-on-social-media redirects: [] +archivedreason: null --- diff --git a/rules/do-you-create-an-online-itinerary/rule.md b/rules/do-you-create-an-online-itinerary/rule.md index 7ec422efe59..b91f1b41636 100644 --- a/rules/do-you-create-an-online-itinerary/rule.md +++ b/rules/do-you-create-an-online-itinerary/rule.md @@ -1,21 +1,21 @@ --- type: rule -archivedreason: +archivedreason: null title: Do you create an online itinerary when traveling? guid: 66c1fa86-8bea-4638-a4dc-15c3361292e8 uri: do-you-create-an-online-itinerary created: 2015-04-28T05:11:40.0000000Z authors: -- title: Adam Cogan - url: https://ssw.com.au/people/adam-cogan -- title: Joanna Feely - url: https://ssw.com.au/people/joanna-feely + - title: Adam Cogan + url: https://ssw.com.au/people/adam-cogan + - title: Joanna Feely + url: https://ssw.com.au/people/joanna-feely related: -- do-you-know-the-best-online-accommodation-websites -- do-you-check-if-your-qantas-flight-is-eligible-for-a-bid-now-upgrade -- do-you-know-how-to-get-the-most-out-of-your-credit-card -- do-you-check-your-boarding-pass -- do-you-take-advantage-of-business-rewards-programs + - do-you-know-the-best-online-accommodation-websites + - do-you-check-if-your-qantas-flight-is-eligible-for-a-bid-now-upgrade + - do-you-know-how-to-get-the-most-out-of-your-credit-card + - do-you-check-your-boarding-pass + - do-you-take-advantage-of-business-rewards-programs redirects: [] --- diff --git a/rules/do-you-establish-a-Lean-Agile-mindset-across-all-teams/rule.md b/rules/do-you-establish-a-Lean-Agile-mindset-across-all-teams/rule.md index c8c1ed8cffb..c6b216df942 100644 --- a/rules/do-you-establish-a-Lean-Agile-mindset-across-all-teams/rule.md +++ b/rules/do-you-establish-a-Lean-Agile-mindset-across-all-teams/rule.md @@ -9,9 +9,10 @@ authors: url: https://ssw.com.au/people/gert-marx - title: Ulysses Maclaren url: https://ssw.com.au/people/ulysses-maclaren -related: +related: [] redirects: - - do-you-establish-a-Lean-Agile-mindset-across-all-teams + - do-you-establish-a-Lean-Agile-mindset-across-all-teams +archivedreason: null --- In any bustling organization, it's common to see multiple teams working at their own pace, each with its distinct flavor of 'agility'. But what happens when some of those flavors are a tad outdated? The result: a mix of inefficiencies, delays, and missed beats. diff --git a/rules/do-you-make-business-travel-easier/rule.md b/rules/do-you-make-business-travel-easier/rule.md index 02696fdb22e..148519fd3fe 100644 --- a/rules/do-you-make-business-travel-easier/rule.md +++ b/rules/do-you-make-business-travel-easier/rule.md @@ -12,7 +12,7 @@ redirects: - uber-for-business created: 2024-01-11T00:00:00.000Z guid: e9a7a3e1-1c1c-4b9b-9160-6ff426e53b6d - +archivedreason: null --- In our fast-paced work environment, it is crucial to get to client sites or attend meetings efficiently. However, managing the associated expenses can often be a time-consuming and challenging task. diff --git a/rules/document-discoveries/rule.md b/rules/document-discoveries/rule.md index 3acd66383b8..7282620e9f5 100644 --- a/rules/document-discoveries/rule.md +++ b/rules/document-discoveries/rule.md @@ -1,14 +1,17 @@ --- type: rule title: Do you document discoveries and decisions? +guid: e625ed0e-b800-4d0d-bc2a-696983b52f84 uri: document-discoveries +created: 2022-09-15T14:07:00.000Z authors: - title: Tylah Kapa url: https://www.ssw.com.au/people/tylah-kapa - title: Piers Sinclair url: https://www.ssw.com.au/people/piers-sinclair -created: 2022-09-15T14:07:00.000Z -guid: e625ed0e-b800-4d0d-bc2a-696983b52f84 +redirects: [] +related: [] +archivedreason: null --- Work items often have a great description and Acceptance Criteria. However, work can change quickly; sometimes, the justification for those changes ends up in emails or instant messages. diff --git a/rules/find-your-license/rule.md b/rules/find-your-license/rule.md index 7872c01bed5..e5f18d61b69 100644 --- a/rules/find-your-license/rule.md +++ b/rules/find-your-license/rule.md @@ -11,6 +11,9 @@ authors: url: https://www.ssw.com.au/people/gordon-beeming/ created: 2024-04-05T03:45:24.386Z guid: d4f35ecb-7e7f-4f96-af43-b4c8b9e9eb72 +related: [] +redirects: [] +archivedreason: null --- Some companies want to keep their projects closed-source in order to profit from their products. However, there are several benefits to keeping the source open including: @@ -29,12 +32,12 @@ This is not legal advice. If you want to explore your options around licensing y As per GitHub's [documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository), no author is obligated to choose a license for their project. Without a license, the default copyright laws will apply. -### Pros: +### Pros * No Effort: No effort required on the author's part. * Some control: Retains some control of the source-code. -### Cons: +### Cons * Not Permissive: Generally, users will have no permission from the author to use, modify or share the software. However, GitHub allows users to Fork and view code as a part of their terms. @@ -42,17 +45,18 @@ As per GitHub's [documentation](https://docs.github.com/en/repositories/managing The [MIT License](https://choosealicense.com/licenses/mit/) is a well known license trusted by many open-source projects. -Examples include: -- [Dotnet](https://github.com/dotnet/runtime/blob/main/LICENSE.TXT) -- [Ruby on Rails](https://github.com/rails/rails/blob/main/MIT-LICENSE) +Examples include: + +* [Dotnet](https://github.com/dotnet/runtime/blob/main/LICENSE.TXT) +* [Ruby on Rails](https://github.com/rails/rails/blob/main/MIT-LICENSE) -### Pros: +### Pros * Permissive: Allows for commercial and private use as well as distribution and modification of the author's software. * Collaboration + Community: Promotes an open and collaborative environment with community feedback. * Short and simple: The text of the license is simple and quick to understand. -### Cons: +### Cons * Limited Patent Protection: The MIT License doesn't include explicit patent grants or protections. * Lack of clarity on Trademarks: The license doesn't address the use of Trademarks associated with the software @@ -62,17 +66,18 @@ Examples include: A copyleft license like the [Gnu Public License](https://choosealicense.com/licenses/gpl-3.0/) promote and protect the principals of open-source software. Though they may also introduce complexities and potential limitations that users may be deterred by. Examples include: -- [Ansible](https://github.com/ansible/ansible/blob/devel/COPYING) -- [Bash](https://git.savannah.gnu.org/cgit/bash.git/tree/COPYING) -### Pros: +* [Ansible](https://github.com/ansible/ansible/blob/devel/COPYING) +* [Bash](https://git.savannah.gnu.org/cgit/bash.git/tree/COPYING) + +### Pros * Collaboration + Community: Promotes an open and collaborative environment with community feedback. * Protection Against Exploitation: Guards against consumers taking the source code and making proprietary modifications in a closed environment. -### Cons: +### Cons -* Complexity: Some developers and organizations may find a copyleft license to be too complex and stringent. +* Complexity: Some developers and organizations may find a copyleft license to be too complex and stringent. * Perceived Risk: Copyleft licenses may discourage contributors or participators through perceived risk. ## Option 4 - Proprietary @@ -80,33 +85,35 @@ Examples include: Companies often use a proprietary license when they prefer to have fine-grained control over their intellectual property. Examples include: -- [Mozilla](https://www.mozilla.org/en-US/MPL/) -- [Duende](https://duendesoftware.com/license) -### Pros: +* [Mozilla](https://www.mozilla.org/en-US/MPL/) +* [Duende](https://duendesoftware.com/license) + +### Pros * Better control: Authors have fine-grained control over their source code and how it's used. * Benefits of community development: Authors can still benefit from the community engaging with their source code -### Cons: +### Cons * Cost: Drafting and iterating upon your license will cost time and money. * Bad actors: Authors will need to be vigilant of bad actors abusing the license and choose to pursue them. ## Option 5 - Functional Source License (FSL) -Sentry introduced the [FSL](https://fsl.software/) as a way to support the open-source community whilst retaining control over their IP. +Sentry introduced the [FSL](https://fsl.software/) as a way to support the open-source community whilst retaining control over their IP. Examples of projects with this license include: -- [Sentry](https://github.com/getsentry/self-hosted/blob/master/LICENSE.md) -- [GitButler](https://github.com/gitbutlerapp/gitbutler/blob/master/LICENSE.md) -### Pros: +* [Sentry](https://github.com/getsentry/self-hosted/blob/master/LICENSE.md) +* [GitButler](https://github.com/gitbutlerapp/gitbutler/blob/master/LICENSE.md) + +### Pros * Protection: Retains control over source code for up to 2 years * Free and Open-Source Software (FOSS) Values: Automatically converts to MIT/Apache 2.0 licensing after 2 years * Continual Iteration: Pushes the author to continually iterate on their project or risk third-parties competing with a forked version of the project. -### Cons: +### Cons * Not strictly Open-Source: While Sentry values FOSS, this license does not meet the strict definition of open-source. diff --git a/rules/forms-value/rule.md b/rules/forms-value/rule.md index ed36b005f5f..e71c8c9d1f7 100644 --- a/rules/forms-value/rule.md +++ b/rules/forms-value/rule.md @@ -7,6 +7,7 @@ authors: url: https://www.ssw.com.au/people/adam-cogan/ created: 2022-02-04T00:39:27.916Z guid: 3d41f831-c7d7-4e80-81b1-2bd2a7f36a26 +archivedreason: null --- Microsoft Forms and Google Forms provide an invaluable way of collecting data from your employees, users and other stakeholders. It's important to understand if their experience of providing this feedback is a good or a bad one. diff --git a/rules/implement-business-logic-in-middle-tier/rule.md b/rules/implement-business-logic-in-middle-tier/rule.md index af907b3dfe2..499999c9df1 100644 --- a/rules/implement-business-logic-in-middle-tier/rule.md +++ b/rules/implement-business-logic-in-middle-tier/rule.md @@ -1,16 +1,16 @@ --- type: rule -archivedreason: +archivedreason: null title: Middle Tier - Do you implement business logic in middle tier? guid: 66e5d862-74c1-440d-89df-3c27ab1d0485 uri: implement-business-logic-in-middle-tier created: 2019-11-14T22:30:36.0000000Z authors: -- title: Adam Cogan - url: https://ssw.com.au/people/adam-cogan + - title: Adam Cogan + url: https://ssw.com.au/people/adam-cogan related: [] redirects: -- middle-tier-do-you-implement-business-logic-in-middle-tier + - middle-tier-do-you-implement-business-logic-in-middle-tier --- diff --git a/rules/limit-duration/rule.md b/rules/limit-duration/rule.md index 1e9d128e7b9..60c4f5811d6 100644 --- a/rules/limit-duration/rule.md +++ b/rules/limit-duration/rule.md @@ -7,6 +7,7 @@ authors: url: https://ssw.com.au/people/ulysses-maclaren/ created: 2024-02-28T22:58:09.052Z guid: b33dbb23-15e6-4dfc-b0f0-66d23c095ce4 +archivedreason: null --- Limiting the duration of board meetings encourages efficiency and ensures that members remain engaged and focused throughout the session. diff --git a/rules/make-complaints-a-positive-experience/rule.md b/rules/make-complaints-a-positive-experience/rule.md index f11559ac0f3..f9883883b9a 100644 --- a/rules/make-complaints-a-positive-experience/rule.md +++ b/rules/make-complaints-a-positive-experience/rule.md @@ -14,6 +14,7 @@ redirects: - do-you-make-complaints-a-positive-experience created: 2018-06-08T22:41:25.000Z guid: 864742c9-9c2a-4e8b-b4ee-96d3ac761575 +archivedreason: null --- Nobody likes to hear they have an unhappy customer, but it happens. Maybe a deadline was missed, or a feature didn't work out as expected, or perhaps the client's just having a bad day. 🤬 diff --git a/rules/manage-travel-in-centralized-systems/rule.md b/rules/manage-travel-in-centralized-systems/rule.md index da66802472b..aa783173396 100644 --- a/rules/manage-travel-in-centralized-systems/rule.md +++ b/rules/manage-travel-in-centralized-systems/rule.md @@ -13,6 +13,7 @@ redirects: - travel-management-in-centralized-systems created: 2024-02-22T00:00:00.000Z guid: aefbe7e0-1909-42de-8d7d-d8fdf029b003 +archivedreason: null --- When employees need to travel between offices or various locations, they typically require accommodation, flights, transportation, and other necessities. Managing these bookings, obtaining approvals, and handling tax invoices can be both costly and time consuming. diff --git a/rules/manage-youtube-livestream-content/rule.md b/rules/manage-youtube-livestream-content/rule.md index b1bdd12f414..9d27b79aef3 100644 --- a/rules/manage-youtube-livestream-content/rule.md +++ b/rules/manage-youtube-livestream-content/rule.md @@ -8,6 +8,7 @@ authors: related: [] created: 2023-04-04T00:48:02.841Z guid: d06aec44-046e-4119-9769-d8101cf4da38 +archivedreason: null --- When it comes to live streaming to YouTube and editing the livestream for re-publication post-event, there are a few common pain points that can arise: diff --git a/rules/minimize-unrelated-interruptions/rule.md b/rules/minimize-unrelated-interruptions/rule.md index 06f335b81c9..2ce53cd61e9 100644 --- a/rules/minimize-unrelated-interruptions/rule.md +++ b/rules/minimize-unrelated-interruptions/rule.md @@ -1,6 +1,6 @@ --- type: rule -archivedreason: +archivedreason: null title: Group calls - Do you minimize unrelated interruptions? guid: 6acf2794-acef-4744-9173-4ac3c80a27bf uri: minimize-unrelated-interruptions diff --git a/rules/monitor-seo-effectively/rule.md b/rules/monitor-seo-effectively/rule.md index 415f67b0895..32ebc8ce02b 100644 --- a/rules/monitor-seo-effectively/rule.md +++ b/rules/monitor-seo-effectively/rule.md @@ -40,7 +40,7 @@ SEO means working with a large amount of data. A single website can have even up #### SEMrush -[SEMrush](semrush.com) connects to Google Analytics and provides an informative and customizable user interface for understanding a website's data. It helps show how a site ranks on Google, what keywords to use, comparisons to competitors and more. Its goal is to help improve online visibility and marketing strategies. +[SEMrush](https://semrush.com) connects to Google Analytics and provides an informative and customizable user interface for understanding a website's data. It helps show how a site ranks on Google, what keywords to use, comparisons to competitors and more. Its goal is to help improve online visibility and marketing strategies. ![Figure: SEMrush dashboard shows information we can use to improve our website](semrush1.jpg) diff --git a/rules/do-you-prioritize-value-streams-over-individual-projects/Adaption.png b/rules/prioritise-value-streams-over-individual-projects/Adaption.png similarity index 100% rename from rules/do-you-prioritize-value-streams-over-individual-projects/Adaption.png rename to rules/prioritise-value-streams-over-individual-projects/Adaption.png diff --git a/rules/do-you-prioritize-value-streams-over-individual-projects/Alignment.png b/rules/prioritise-value-streams-over-individual-projects/Alignment.png similarity index 100% rename from rules/do-you-prioritize-value-streams-over-individual-projects/Alignment.png rename to rules/prioritise-value-streams-over-individual-projects/Alignment.png diff --git a/rules/do-you-prioritize-value-streams-over-individual-projects/Deployment.png b/rules/prioritise-value-streams-over-individual-projects/Deployment.png similarity index 100% rename from rules/do-you-prioritize-value-streams-over-individual-projects/Deployment.png rename to rules/prioritise-value-streams-over-individual-projects/Deployment.png diff --git a/rules/do-you-prioritize-value-streams-over-individual-projects/rule.md b/rules/prioritise-value-streams-over-individual-projects/rule.md similarity index 97% rename from rules/do-you-prioritize-value-streams-over-individual-projects/rule.md rename to rules/prioritise-value-streams-over-individual-projects/rule.md index bc3707df112..8d9246505df 100644 --- a/rules/do-you-prioritize-value-streams-over-individual-projects/rule.md +++ b/rules/prioritise-value-streams-over-individual-projects/rule.md @@ -11,8 +11,8 @@ authors: url: https://ssw.com.au/people/ulysses-maclaren related: redirects: - - do-you-prioritise-value-streams-over-individual-projects - + - do-you-prioritise-value-streams-over-individual-projects +archivedreason: null --- Imagine managing a bunch of projects, each with its own goals and deadlines. It's easy to get caught up in the details and miss the bigger picture. Sometimes, even though every project seems super important, they might not all line up with what the business really needs. That's when you realize: it's all about focusing on value streams, not just individual projects. diff --git a/rules/review-automated-tests/rule.md b/rules/review-automated-tests/rule.md index 8ee9ec9c0ea..72146b1bcdf 100644 --- a/rules/review-automated-tests/rule.md +++ b/rules/review-automated-tests/rule.md @@ -9,6 +9,7 @@ related: - automated-test-code-first-class-citizen created: 2022-12-01T01:09:23.840Z guid: d823e149-327c-48dd-9049-12165573afd6 +archivedreason: null --- Reliable suites of automated tests can provide a lot of value to your development effort, giving fast feedback and alerting you to unexpected problems introduced by recent code changes. @@ -19,7 +20,8 @@ Automated test code ages just like any other code, though, and it's common to se Your automated tests require periodic attention and review — or else they're like smoke detectors, scattered throughout enormous buildings, whose batteries and states of repair are uncertain. As Jerry Weinberg said: > Most of the time, a non-functioning smoke alarm is behaviorally indistinguishable from one that works. Sadly, the most common reminder to replace the batteries is a fire." -> - Jerry Weinberg +> +> * Jerry Weinberg diff --git a/rules/scrum-should-be-capitalized/rule.md b/rules/scrum-should-be-capitalized/rule.md index ca464f66751..4f3bab60c27 100644 --- a/rules/scrum-should-be-capitalized/rule.md +++ b/rules/scrum-should-be-capitalized/rule.md @@ -1,17 +1,18 @@ --- type: rule -archivedreason: -title: Do you know "Scrum" (and other Scrum terms) should be capitalized? +archivedreason: null +title: | + Do you know "Scrum" (and other Scrum terms) should be capitalized? guid: b0fdd7d0-664d-44ea-8cf8-7773c15becf4 uri: scrum-should-be-capitalized created: 2020-03-11T00:28:43.0000000Z authors: -- title: Adam Cogan - url: https://ssw.com.au/people/adam-cogan + - title: Adam Cogan + url: https://ssw.com.au/people/adam-cogan related: -- use-the-right-capitalization + - use-the-right-capitalization redirects: -- tiny-do-you-know-scrum-should-be-capitalized + - tiny-do-you-know-scrum-should-be-capitalized --- diff --git a/rules/show-certification-award/rule.md b/rules/show-certification-award/rule.md index 8375ee95bb3..542e9a337fb 100644 --- a/rules/show-certification-award/rule.md +++ b/rules/show-certification-award/rule.md @@ -8,21 +8,22 @@ authors: related: [] created: 2024-04-08T06:55:48.587Z guid: 94ab00f4-a6d5-4e8f-aca3-68d6cc0a3498 +archivedreason: null --- Encouraging professional development and recognizing achievements are crucial for fostering a positive workplace culture. SSW's Certification Reward system is a testament to this, offering additional leave to employees who complete Microsoft certifications. This initiative not only motivates employees to pursue further learning but also highlights the company's commitment to staying at the forefront of technology. - + - + ### Understanding Certification Rewards - + Certification Reward is a special category of leave granted to employees as a form of recognition for their effort and time invested in completing Microsoft certifications. Here's how it works: - + 1. **Award Criteria:** Employees become eligible for a Certification Reward upon successfully completing a Microsoft certification 2. **Visibility and Tracking:** A distinct leave category should be used within your accounting system specifically for Certification Reward - + ### Not a Fairwork Mandate - + It's important to note that the Certification Reward is not mandated by Fairwork. Instead, it's a proactive approach to incentivize its team members to engage in professional development, specifically around Microsoft technologies. This strategic focus not only enhances individual skill sets but also elevates the collective expertise within the company, ensuring you remain competitive and innovative in delivering solutions. - + The Certification Reward system exemplifies how valuing and investing in employees' growth can create a dynamic and forward-thinking workplace culture. It's a clear win-win: employees expand their expertise, and strengthens your company's capability to deliver cutting-edge solutions. diff --git a/rules/show-long-service-leave-on-your-payslip/rule.md b/rules/show-long-service-leave-on-your-payslip/rule.md index 7797d1fb190..af1e2274b6e 100644 --- a/rules/show-long-service-leave-on-your-payslip/rule.md +++ b/rules/show-long-service-leave-on-your-payslip/rule.md @@ -7,6 +7,7 @@ authors: url: https://www.ssw.com.au/people/stephan-fako/ created: 2024-04-08T04:12:18.064Z guid: a1761f09-26e5-40eb-98bd-48b3a9346357 +archivedreason: null --- Long Service Leave (LSL) is an essential benefit for employees, recognizing their dedication and long-term commitment to a company. Many accounting solutions do not automatically calculate LSL provisions. This lack of automation can lead to transparency issues, as employees may find it difficult to track their LSL balances. Furthermore, the legislation governing LSL varies significantly across regions, adding an extra layer of complexity. For instance, the provisions in Victoria differ from those in New South Wales, necessitating a tailored approach for businesses operating in multiple states. diff --git a/rules/take-care-of-your-personal-presentation-for-remote-meetings/rule.md b/rules/take-care-of-your-personal-presentation-for-remote-meetings/rule.md index 620e966c93d..f59e0d6a9ad 100644 --- a/rules/take-care-of-your-personal-presentation-for-remote-meetings/rule.md +++ b/rules/take-care-of-your-personal-presentation-for-remote-meetings/rule.md @@ -1,20 +1,20 @@ --- type: rule -archivedreason: +archivedreason: null title: Do you take care of your personal appearance even for remote meetings? guid: 3d0d413a-403c-4cde-b879-a485cf2fefea uri: take-care-of-your-personal-presentation-for-remote-meetings created: 2020-03-25T03:16:15.0000000Z authors: -- title: Adam Cogan - url: https://ssw.com.au/people/adam-cogan -- title: Camilla Rosa Silva - url: https://ssw.com.au/people/camilla-rosa-silva -- title: Steven Andrews - url: https://ssw.com.au/people/steven-andrews + - title: Adam Cogan + url: https://ssw.com.au/people/adam-cogan + - title: Camilla Rosa Silva + url: https://ssw.com.au/people/camilla-rosa-silva + - title: Steven Andrews + url: https://ssw.com.au/people/steven-andrews related: [] redirects: -- do-you-take-care-of-your-personal-appearance-even-for-remote-meetings + - do-you-take-care-of-your-personal-appearance-even-for-remote-meetings --- diff --git a/rules/tell-chatgpt-to-ask-questions/rule.md b/rules/tell-chatgpt-to-ask-questions/rule.md index 64c8f5b1498..11a23b1a36b 100644 --- a/rules/tell-chatgpt-to-ask-questions/rule.md +++ b/rules/tell-chatgpt-to-ask-questions/rule.md @@ -7,6 +7,7 @@ authors: url: https://www.ssw.com.au/people/ulysses-maclaren created: 2023-04-12T13:40:52.200Z guid: e4324d4e-5157-4674-8eca-8f3d6ecda1ab +archivedreason: null --- Sometimes, ChatGPT may require more context or clarification to provide a helpful response. Encouraging the model to ask questions when it needs more information can improve the quality of its answers and prevent misunderstandings. diff --git a/rules/ticks-crosses/rule.md b/rules/ticks-crosses/rule.md index 786f03da7f2..3ba4f7c2b85 100644 --- a/rules/ticks-crosses/rule.md +++ b/rules/ticks-crosses/rule.md @@ -11,7 +11,7 @@ authors: url: https://ssw.com.au/people/sofie-hong created: 2022-12-20T12:33:58.820Z guid: 4ed7f75b-927b-4f70-b1f1-954df10a5842 - +archivedreason: null --- Sometimes a video editor wants to communicate good and bad examples to the audience, but they aren't sure the best way to do that. Ticks (✅) and crosses (❌) with sound effects are a great way to highlight good and bad examples to the audience, but they only work if used correctly. @@ -79,7 +79,7 @@ Standarding your ticks and crosses using a lower third helps the team have a con ![Figure: Good example - The red cross and bad example in the lower third + subtle sound - 0:58 - 1:07](rules/ticks-crosses/Do you ask for small content changes using from X to Y.png) ::: ---- +---- ::: greybox diff --git a/rules/use-net-maui/rule.md b/rules/use-net-maui/rule.md index 32314845feb..c3b380b2661 100644 --- a/rules/use-net-maui/rule.md +++ b/rules/use-net-maui/rule.md @@ -1,6 +1,7 @@ --- type: rule -title: Do you use .NET MAUI (was Xamarin)? +title: | + Do you use .NET MAUI (was Xamarin)? uri: use-net-maui authors: - title: Adam Cogan @@ -12,8 +13,9 @@ redirects: - do-you-use-xamarin-forms - use-xamarin-forms created: 2020-10-05T22:18:32.000Z -archivedreason: Replaced by [https://www.ssw.com.au/rules/build-cross-platform-apps](/rules/build-cross-platform-apps) guid: 954d9b68-7185-472b-917c-407aa1a7df26 +archivedreason: | + Replaced by [https://www.ssw.com.au/rules/build-cross-platform-apps](/rules/build-cross-platform-apps) --- Xamarin has evolved beyond simply being an abstraction of the platform native APIs for iOS, Android, and UWP. It is now the .NET Multi-platform App UI (.NET MAUI). diff --git a/rules/use-nunit-to-write-unit-tests/rule.md b/rules/use-nunit-to-write-unit-tests/rule.md index 85c90e91055..5e1f8d684a4 100644 --- a/rules/use-nunit-to-write-unit-tests/rule.md +++ b/rules/use-nunit-to-write-unit-tests/rule.md @@ -7,7 +7,9 @@ authors: url: https://ssw.com.au/people/adam-cogan/ created: 2014-03-14T00:22:00.000Z guid: 63a5f8ba-42ad-4d32-aa65-7b9c1fdab799 -archived: See a more generic and up to date rule https://www.ssw.com.au/rules/rules-to-better-unit-tests/ +related: [] +redirects: [] +archivedreason: See a more generic and up to date rule [https://www.ssw.com.au/rules/rules-to-better-unit-tests/](/rules/rules-to-better-unit-tests) --- When anyone sends you a bug that happen in their environment do a unit test. Just because the code runs on your machine it doesnt mean it will work on the users machine. E.g permissions issues - you are an admin while the user is only a simple user, registry & io reads might fail, NUnit will test for this and let you know. @@ -21,7 +23,7 @@ You should always try to write unit tests for: 2. Any regular expressions (as these change it is easy to change functionality and cause errors) 3. Any external factors that your program relies on like hyperlinks to websites -One important test that should be implemented (if your setup package or build script doesn't pick it up) is to validate that your application installs all required DLLs. .NET loads DLLs just in time (JIT) - which means that a missing DLL is will not generate an error unless it is required. +One important test that should be implemented (if your setup package or build script doesn't pick it up) is to validate that your application installs all required DLLs. .NET loads DLLs just in time (JIT) - which means that a missing DLL is will not generate an error unless it is required. Example: You may have a shared project that your application uses. Another developer adds a reference to that project - unbeknownst to you. You build the application with no errors, and the application passes basic user testing. Problem is that the user did not run the tutorial component - which is missing from the setup package. Users who run the tutorial report runtime errors. You can resolve this issue by creating a unit test to check that all DLLs are included in the setup. @@ -35,4 +37,4 @@ For more information on unit testing see [Rules to Better Unit Tests](https://ss Also see [Suggestions to TFS](https://ssw.com.au/ssw/Standards/BetterSoftwareSuggestions/TeamFoundationServer.aspx) -We have a program called [SSW .NET Toolkit](https://ssw.com.au/ssw/NETToolkit/) that implements these Unit Tests +We have a program called [SSW .NET Toolkit](https://ssw.com.au/ssw/NETToolkit/) that implements these Unit Tests diff --git a/rules/use-pull-request-templates-to-communicate-expectations/rule.md b/rules/use-pull-request-templates-to-communicate-expectations/rule.md index c69b7a1df49..a051cdda1ac 100644 --- a/rules/use-pull-request-templates-to-communicate-expectations/rule.md +++ b/rules/use-pull-request-templates-to-communicate-expectations/rule.md @@ -1,6 +1,6 @@ --- type: rule -title: Do you use Pull Request templates to communicate expectations? +title: Do you use Pull Request templates to specify the expectations and requirements for each PR? uri: use-pull-request-templates-to-communicate-expectations authors: - title: Gordon Beeming @@ -13,18 +13,20 @@ authors: url: https://ssw.com.au/people/adam-cogan - title: Seth Daily url: https://ssw.com.au/people/seth-daily +related: + - write-a-good-pull-request created: 2023-09-06T16:24:00.000Z guid: 8e378b56-3161-4433-81c0-40119075d137 - +archivedreason: null --- -Pull Request templates are a great way to communicate expectations to developers. You should can create different PR templates for different types of PRs. For example, you can have a PR template for bug fixes, a PR template for new features, and a PR template for refactoring. You are also able to create specific PR templates for specific code paths. - -You can read more about PR templates in the GitHub docs at [Creating a pull request template for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository) +Pull Request templates are a great way to communicate expectations to developers. You should create different PR templates for different types of PRs. For example, you can have a PR template for bug fixes, a PR template for new features, and a PR template for refactoring. You are also able to create specific PR templates for specific code paths. -When creating a PR template, think of how you can help developers create great PRs +You can read how to implement PR templates in the [GitHub Docs - Creating a pull request template for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository). + +When creating a PR template, think of how you can help developers create great PRs. ::: bad ![Figure: Bad example - There is no information to guide developers](no-pr-template.jpg) @@ -35,9 +37,9 @@ When creating a PR template, think of how you can help developers create great P ::: ::: good -![Figure: Good example - This PR template asks for **context needed to review**, along with links to guidance for creating great PRs ⭐](pr-template-asking-for-context.jpg) +![Figure: Good example - This PR template asks for context (to help reviewers), along with guidance links for creating great PRs ⭐](pr-template-asking-for-context.jpg) ::: -**Tip:** You can use comments in the markdown as above. These comments will not show when the PR is created, and is only visible when editing the description. - -For a great Pull Request template, take a look at [@SSWConsulting/SSW.GitHub.Template](https://github.com/SSWConsulting/SSW.GitHub.Template/blob/main/.github/pull_request_template.md) +**Tip:** You can use comments in the Markdown as above. These comments will not show when the PR is created, and is only visible when editing the description. + +For a great Pull Request template, take a look at [@SSWConsulting/SSW.GitHub.Template](https://github.com/SSWConsulting/SSW.GitHub.Template/blob/main/.github/pull_request_template.md). diff --git a/rules/use-the-right-capitalization/rule.md b/rules/use-the-right-capitalization/rule.md index cd29c3786ff..36f01ae05db 100644 --- a/rules/use-the-right-capitalization/rule.md +++ b/rules/use-the-right-capitalization/rule.md @@ -1,18 +1,18 @@ --- type: rule -archivedreason: +archivedreason: null title: Do you know to capitalize tech terms correctly? guid: ba19431b-408b-4a8a-806e-9f296458ba2b uri: use-the-right-capitalization created: 2016-04-21T07:37:05.0000000Z authors: -- title: Joanna Feely - url: https://ssw.com.au/people/joanna-feely + - title: Joanna Feely + url: https://ssw.com.au/people/joanna-feely related: -- how-to-capitalize-titles -- scrum-should-be-capitalized + - how-to-capitalize-titles + - scrum-should-be-capitalized redirects: -- do-you-know-to-capitalize-tech-terms-correctly + - do-you-know-to-capitalize-tech-terms-correctly --- diff --git a/rules/what-is-mentoring/rule.md b/rules/what-is-mentoring/rule.md index cd40cdcd8d7..0b2e8891fb8 100644 --- a/rules/what-is-mentoring/rule.md +++ b/rules/what-is-mentoring/rule.md @@ -11,6 +11,7 @@ related: - the-best-way-to-learn created: 2021-09-22T06:33:25.431Z guid: 1c0eb0db-03da-464a-98ba-286cc6f66fbe +archivedreason: null --- Trying to do great things is hard. Trying to do them alone is, more often than not, impossible. That’s why all great leaders have mentors, and they also mentor others. No matter how competitive you may feel - especially early in your career - success is, in reality, a team sport. diff --git a/rules/write-a-good-pull-request/rule.md b/rules/write-a-good-pull-request/rule.md index f80a249dc7b..fdefcc5d128 100644 --- a/rules/write-a-good-pull-request/rule.md +++ b/rules/write-a-good-pull-request/rule.md @@ -119,25 +119,6 @@ Figure: Bad example - Cannot tell what was done here ::: greybox **PR title:** Update Rule “meaningful-pbi-titles/rule” -**PR description:** Changes made: - -1. Added missing video figure to embedded YouTube video -2. Fixed typo:\ - From:\ - Use emojis. See our rule on emojis in Scrum).\ - To:\ - Use emojis. See our rule on emojis in Scrum - -::: -::: ok -Figure: OK example - What was done is clear, but both editor and reviewer may spend too much time on the description of such simple changes -::: - -Try to make generic comments that objectively summarize your changes. This way the reviewer will know what to expect and confirm the changes by looking at the file diffs. - -::: greybox -**PR title:** Update Rule “meaningful-pbi-titles/rule” - **PR description:** Added missing video caption + removed unnecessary brackets ::: ::: ok @@ -159,6 +140,12 @@ Figure: Good example - It's clear what changes are being made and where the task There is also well-known Pull Request semantics like [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) on how to write a PR body, but we can still have a great PR without using such preciseness. ::: +### How to approach making a Pull Request + +`youtube: https://www.youtube.com/watch?v=d8yGY6KsYys&t=29s` + +**Video: 5 Tips For Better Pull Requests (11 min)** + #### FAQs **Q: Are you making many small changes?** @@ -170,14 +157,6 @@ A: You should summarize by saying: *“Improved readability”* OR *“Fixed typ A: You should include a demonstration of the change. E.g. A [screenshot](/screenshots-avoid-walls-of-text) to show text/UI changes, or a [Done video](/record-a-quick-and-dirty-done-video) to demo functionality changes. -**Q: Are you using a GUI editor (like Netlify or Tina)** +**Q: Are you using a CMS editor (like Netlify or Tina)** -A: If you're using a GUI editor for your PRs, you may need to go to the PR afterward and update the description to include the context - -::: bad -![Figure: Bad example - An automatically generated description doesn't give any context to reviewers](cms-bad-example.png) -::: - -::: good -![Figure: Good example - Updating the PR description to follow the repository standard helps you provide context to reviewers](cms-good-example.png) -::: +A: CMS editors may automatically add a placeholder description. If you're using a CMS to make your changes, you may need to go to the PR afterward and update the description to include the context.