Comments (2)
Hi @ino-iosdev.
Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:
- Complexity, Role, Feature
NOTE: Please ignore this comment if you do not have 'write' access to this directory.
To add a label, take a look at Github's documentation here.
Also, don't forget to remove the "missing labels" afterwards.
To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.
After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.
Additional Resources:
from website.
Hey @ino-iosdev good start on this!
Here are some suggestions:
- If this were my ER, I would approach this more from the standpoint of “We want the title of the PR to clearly summarize how the dev resolved the issue. When devs unnecessarily include the issue number in the title, the issue number collides with the PR number making it unclear which is which, and is a detriment to clear communication.” Or something to that effect.
- It may be helpful to crop down the first screenshot to emphasize the circled area.
- I think that it would help to remove the second screenshot. I understand what you are saying, but I think the first screenshot illustrates the point and the second only distracts from your argument. Also, although it might not be strictly the case in this exact instance, when we link them, the issue and PR number usually appears at the end.
- For the “Potential solutions [draft]”, you will want to reference a specific area of code where the solution would be applied- think of it as you are writing an issue and need to tell a dev exactly what needs to be changed. For example, since you are recommending a change to the way devs title their PRs, the applicable code is
CONTRIBUTING.md
, Section 3.1.b.i. around or after line 889 (your 2nd screenshot). Where our docs say- Please change it to provide a summary of what you did.
you could recommend adding another bullet- Note: Please do not include the issue number in the PR title; a PR number will be added automatically.
or some such.
For the labels: role: back end/devOps, complexity: depending on the change this might be a good first issue, and feature: this would be p-feature: onboarding/contributing.md
One final thing, if this is approved, you should volunteer to write the issue for it.
from website.
Related Issues (20)
- Update CONTRIBUTING.md Section 2.3 HOT 1
- Add github-handle for Priyanka Talwar in tech-work-experience.md
- Add github-handle for Joshua Fishman in tech-work-experience.md
- Add github-handle for Yingjie Ou in tech-work-experience.md HOT 2
- Add github-handle for Hyun Joo Sandy Oh in tech-work-experience.md
- Add github-handle for Sara Brady in tech-work-experience.md
- Add github-handle for Andrew Salvatore in tech-work-experience.md
- Add github-handle for Angela Darosh in tech-work-experience.md
- Add github-handle for Bryanna Lim in tech-work-experience.md
- Add github-handle for Brian Dick in tech-work-experience.md HOT 1
- Add github-handle for Jessie Liu in tech-work-experience.md
- Add github-handle for Minji Kim in tech-work-experience.md
- Add github-handle for Natalie Aguilar in tech-work-experience.md
- Add github-handle for Nino Dzotsenidze in tech-work-experience.md
- Add github-handle for Eric Vennemeyer in tech-work-experience.md
- Update Project Profile: Guides Team
- Create Issues to add new variable github-handle for members in youthjusticenav.md HOT 1
- Create Issues to add new variable github-handle for members in vrms.md HOT 1
- Create Issues to add new variable github-handle for members in website.md HOT 1
- Create Issues to add new variable github-handle for members in work-for-la.md HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from website.