renun/NetNewsWire
1
0
Fork 0
mirror of https://github.com/Ranchero-Software/NetNewsWire synced 2025-08-12 06:26:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Revise the contributing document to make it more clear about asking first.

Browse Source
This commit is contained in:
Brent Simmons
2025-05-22 21:49:02 -07:00
parent 49efb15be5
commit 712467c8af
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@@ -1,20 +1,20 @@
# Contributing
We welcome contributions!
We welcome contributions — but it’s **really important to ask first** before working on a new feature or bug fix. Just because the app is open source doesn’t mean we add features just whenever someone codes one up. The app is planned the same way it would be if it weren’t open source.
If you’d like to contribute:
Here’s how to contribute:
1. File a ticket describing the bug you want to fix or feature you want to add. Or find an existing ticket.
2. On the [Slack group](https://netnewswire.com/slack), bring it up on the #work channel for discussion (which may or may not include implementation discussion). **This is very important, because there might be things you need to know before you start work.**
1. Find or file a ticket describing the bug you want to fix or feature you want to add.
2. On the [Slack group](https://netnewswire.com/slack), bring it up on the #work channel for discussion (which may or may not include implementation discussion). **This is very important, because there might be things you need to know before you start work.** We might also, for whatever reason, not want to do that feature, not do it this year, do it in a very different way, or whatever. Or it may be that a given bug fix should come after some other refactoring, for instance.
3. Once approved, then go for it. Write the code, then do a pull request. We’ll either have comments or we’ll merge it. (We might revise it afterward, of course.)
## Notes
It’s important that the pull request merge cleanly with the git branch `main`.
It’s important that the pull request merge cleanly with `main`. It must add no more warnings than we already have. (We try to keep warnings at zero, but aren’t always successful.)
You should have read the [coding guidelines](Technotes/CodingGuidelines.md) first. If your code doesn’t follow the guidelines, we will likely suggest revising it.
Patience may be required at times. Brent has a day job, and sometimes everything happens at once. :)
Patience may be required at times. Brent isn’t always available — just because of life. 🐥
Our code of conduct is below.
@@ -75,7 +75,7 @@ further defined and clarified by project maintainers.
### Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting Brent Simmons at brent@ranchero.com. All
reported by contacting Brent Simmons via direct message on the [Slack group](https://netnewswire.com/slack). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.