-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update contributing.rst and docstyle.rst: refer to a bug via bug #1234
+ other guidelines
#14796
Conversation
issue #1234
Good, but change it to "bug #123", it's shorter and I think I use it more often. |
This doesn't belong into NEP1 IMO, but in |
Should we be really modifying NEP-1 or should we just write a new one called NEP-2? We can probably use a similar process to IETF RFC: RFCs are immutable and updates are published in the form of a new RFC. What is the actual process for introducing these NEPs anyway? I think we kinda obsoleted this with RFCs, but I can be wrong. |
Er, indeed this belongs to the |
4d73e8f
to
f8aa847
Compare
issue #1234
bug #1234
+ other guidelines
2ad8fa5
to
46a303d
Compare
46a303d
to
355f21b
Compare
355f21b
to
f79626a
Compare
IIUC NEP is obsoleted by RFC's repo, but nep1 became synonymous of style guide; that being said, I wouldn't mind someone (carefully) merging
indeed. PTAL (better debate here than in individual PR's about those guidelines) |
principle: "instead of each one guessing or following surrounding code (which encourages dialects), encourage following a single convention"
I don't mind changing that convention to something else that's reasonable, eg
bug #1234
but I'd prefer to have a single fixed convention. Doesn't mean past code needs to be changed/edited but at least future code should.it makes it easier for tooling, as well as simple grep search
refs: https://github.com/nim-lang/Nim/pull/14795/files#r445261335 which was using many different conventions in the same PR:
which makes it awkward to search given that 9313 can come from anywhere (eg port number etc)
note
as a side benefit, this will make those issue links clickable, with some browser extensions (eg: https://github.com/sindresorhus/refined-github) as you can see in the updated #14795; (at least when that extension works, refs refined-github/refined-github#3285)