Skip to content

Commit 4b391f1

Browse files
docs(contributing.md): update and issue tracker links
1 parent e7e7bd9 commit 4b391f1

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ All types of contributions are encouraged and valued. Please make sure to read t
88
- [Question or Problem?](#question-or-problem)
99
- [Features vs Bugs](#features-vs-bugs)
1010
- [For all Issues](#for-all-issues)
11-
- [Submission Guidelines](#submission-guidelines)
11+
- [Submitting an Issue](#submitting-an-issue)
12+
- ['Needs Triage' issue label](#needs-triage-issue-label)
13+
- [Standardization Across App Versions](#standardization-across-app-versions)
14+
- [Before you start working on an Issue](#before-you-start-working-on-an-issue)
15+
- [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)
16+
- [Reviewing a Pull Request](#reviewing-a-pull-request)
1217
- [Coding Rules](#coding-rules)
1318
- [Commit Message Guidelines](#commit-message-guidelines)
1419

@@ -43,11 +48,9 @@ Not all issues are bug fixes! Please understand the difference between a Feature
4348

4449
This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
4550

46-
## Submission Guidelines
51+
## Submitting an Issue
4752

48-
### Submitting an Issue
49-
50-
Before opening an issue, please check the tracker to see if a similar issue has been raised. Existing discussions may provide useful insights or workarounds.
53+
Before opening an issue, please search through Issues to see if a similar issue has been raised. Existing discussions may provide useful insights or workarounds.
5154

5255
To expedite bug fixes, a minimal reproduction of the issue is required. This concise example helps in swiftly identifying and addressing the problem.
5356

@@ -59,11 +62,25 @@ It is always a good practice to look up existing issues and ensure your new issu
5962
format. This helps maintain consistency and makes it easier for others to understand and collaborate on the
6063
issue
6164

62-
### 'Needs Triage' issue label
65+
## 'Needs Triage' issue label
6366

6467
Every new issue is tagged with the "needs triage" label, signifying that it requires review and assessment by a core team member. This process ensures that issues are appropriately prioritized and assigned, fostering a collaborative environment where tasks are synchronized to prevent conflicts. While you focus on addressing an issue, it's important to recognize that others may be working on related tasks. Therefore, the "needs triage" label serves as a precautionary measure, indicating that the issue is not yet ready for immediate attention. The issue will be ready to work on, once the "needs triage" label is removed.
6568

66-
### Submitting a Pull Request (PR)
69+
# Standardization Across App Versions
70+
71+
All app versions maintain consistent file structures, functionalities, and feature implementations deliberately. The variations between versions are minimal, primarily revolving around the utilization of UI components where a UI library is used.
72+
73+
Once an issue has been resolved in one app version, the same implementation must be extended to all other versions, unless a superior alternative is proposed and accepted.
74+
75+
Any new implementation suggestion must be discussed to verify it's suitable for adoption across all app versions. For a good visual representation use the [Issue Tracker](https://anguhashblog.com/issue-tracker)
76+
77+
## Before you start working on an Issue
78+
79+
Before commencing work on any issue, it is essential to confirm that it has not already been addressed. Utilize the [Issue Tracker](https://anguhashblog.com/issue-tracker) tool to check for existing implementations and their corresponding app versions. If the chosen issue has already been resolved in a different app version, consult the [Issue Tracker](https://anguhashblog.com/issue-tracker) to review the existing implementation and replicate it accordingly.
80+
81+
Even if the issue is labeled as not implemented, it remains your responsibility to examine the app's codebase and confirm the absence of the issue.
82+
83+
## Submitting a Pull Request (PR)
6784

6885
Before you submit your Pull Request (PR) consider the following guidelines:
6986

@@ -109,7 +126,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
109126

110127
It is always a good practice to look up already merged PRs and ensure your new PR matches the established format. This helps maintain consistency and makes it easier for others to understand and collaborate.
111128

112-
### Reviewing a Pull Request
129+
## Reviewing a Pull Request
113130

114131
I reserve the right not to accept pull requests from community members who haven't been good citizens of the community.
115132

0 commit comments

Comments
 (0)