Merge pull request #3326 from descodess/improve-markdown
Improve markdown
This commit is contained in:
Maurice Parker
GitHub
commit
941342f122
|
|
@ -5,7 +5,7 @@ We welcome contributions!
|
|||
If you’d like 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, 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.**
|
||||
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.**
|
||||
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
|
||||
|
|
@ -88,7 +88,7 @@ members of the project's leadership.
|
|||
### Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [http://contributor-covenant.org/version/1/4][version]
|
||||
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct/][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
[homepage]: https://www.contributor-covenant.org/
|
||||
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/
|
||||
|
|
|
|||
16
README.md
16
README.md
|
|
@ -1,8 +1,8 @@
|
|||
#  NetNewsWire
|
||||
|
||||
It’s a free and open source feed reader for macOS and iOS.
|
||||
It’s a free and open-source feed reader for macOS and iOS.
|
||||
|
||||
It supports [RSS](http://cyber.harvard.edu/rss/rss.html), [Atom](https://tools.ietf.org/html/rfc4287), [JSON Feed](https://jsonfeed.org/), and [RSS-in-JSON](https://github.com/scripting/Scripting-News/blob/master/rss-in-json/README.md) formats.
|
||||
It supports [RSS](https://cyber.harvard.edu/rss/rss.html), [Atom](https://datatracker.ietf.org/doc/html/rfc4287), [JSON Feed](https://jsonfeed.org/), and [RSS-in-JSON](https://github.com/scripting/Scripting-News/blob/master/rss-in-json/README.md) formats.
|
||||
|
||||
More info: [https://netnewswire.com/](https://netnewswire.com/)
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Here’s [How to Support NetNewsWire](Technotes/HowToSupportNetNewsWire.markdown
|
|||
|
||||
[Join the Slack group](https://netnewswire.com/slack) to talk with other NetNewsWire users — and to help out, if you’d like to, by testing, coding, writing, providing feedback, or just helping us think things through. Everybody is welcome and encouraged to join.
|
||||
|
||||
Every community member is expected to abide by the code of conduct which is included in the [Contributing](CONTRIBUTING.md) page.
|
||||
Every community member is expected to abide by the [code of conduct](CONTRIBUTING.md#code-of-conduct) which is included in the [Contributing](CONTRIBUTING.md) page.
|
||||
|
||||
#### Pull Requests
|
||||
|
||||
|
|
@ -33,10 +33,10 @@ git clone https://github.com/Ranchero-Software/NetNewsWire.git
|
|||
You can locally override the Xcode settings for code signing
|
||||
by creating a `DeveloperSettings.xcconfig` file locally at the appropriate path.
|
||||
This allows for a pristine project with code signing set up with the appropriate
|
||||
developer ID and certificates, and for dev to be able to have local settings
|
||||
developer ID and certificates, and for developer to be able to have local settings
|
||||
without needing to check in anything into source control.
|
||||
|
||||
You can do this in one of two ways: using the included `setup.sh` script or by creating the folder structure and file manually.
|
||||
You can do this in one of two ways: using the included `setup.sh` script or by creating the folder structure and file manually.
|
||||
|
||||
##### Using `setup.sh`
|
||||
|
||||
|
|
@ -46,7 +46,7 @@ You can do this in one of two ways: using the included `setup.sh` script or by c
|
|||
|
||||
##### Manually
|
||||
|
||||
Make a directory SharedXcodeSettings next to where you have this repository.
|
||||
Make a directory `SharedXcodeSettings` next to where you have this repository.
|
||||
|
||||
The directory structure is:
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ The directory structure is:
|
|||
aDirectory/
|
||||
SharedXcodeSettings/
|
||||
DeveloperSettings.xcconfig
|
||||
NetNewsWire
|
||||
NetNewsWire/
|
||||
NetNewsWire.xcworkspace
|
||||
```
|
||||
Example:
|
||||
|
|
@ -90,4 +90,4 @@ functionality disabled. This is because we have API keys that can't be stored i
|
|||
repository or shared between developers. Certain account types, like Feedly, aren't
|
||||
enabled and the Reader View isn't enabled because of this.
|
||||
|
||||
If you have any problems, we will help you out in Slack (see above).
|
||||
If you have any problems, we will help you out in Slack ([see above](README.md#Community)).
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# Accessibility
|
||||
|
||||
Millions of Mac users have some disability or special needs. They use screen readers and special
|
||||
hardware to open up a world that they would otherwise be cut off from. With a small amount of
|
||||
hardware to open up a world that they would otherwise be cut off from. With a small amount of
|
||||
developer work, we can help these users live better lives.
|
||||
|
||||
Because NetNewsWire utilizes standard AppKit controls and views, accessibility is already built in.
|
||||
However this is only a starting point. Any customized controls and views will have accessibility
|
||||
However, this is only a starting point. Any customized controls and views will have accessibility
|
||||
work and the application as a whole has to be tested to make sure users can operate if efficiently.
|
||||
|
||||
This document lays the groundwork to ensure that NetNewsWire has first class accessibility features.
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ This separation is deliberate. There are two main reasons: syncing, and strange
|
|||
|
||||
When syncing with another service, it’s entirely likely that the service will report article status information in calls that are separate from calls to retrieve articles.
|
||||
|
||||
Thus the app might learn about statuses for articles it hasn’t seen yet.
|
||||
Thus, the app might learn about statuses for articles it hasn’t seen yet.
|
||||
|
||||
This way the app can store those statuses without having to have their corresponding articles. And then, when the app does download those articles, it has their statuses already in the database.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,15 +17,15 @@ That is Three-Flow applied to NetNewsWire. It would be that simple, but we have
|
|||
|
||||
Today (6/12/2019) we have 2 branches, main and macOS Candidate, in the main repository which will eventually grow to be 5 branches.
|
||||
|
||||
There will also be a number of repository forks that NetNewWire developers will create to do bug fixes and implement new features (not shown here). Typically contributers will fork the Main branch to thier own repository. They would then create a feature/bugfix branch on their repository. Once work on thier forked branch is complete, they will submit a pull request to be merged back into the main repository main.
|
||||
There will also be a number of repository forks that NetNewWire developers will create to do bug fixes and implement new features (not shown here). Typically, contributors will fork the Main branch to their own repository. They would then create a feature/bugfix branch on their repository. Once work on their forked branch is complete, they will submit a pull request to be merged back into the main repository main.
|
||||
|
||||
## Tagging
|
||||
|
||||
Each release should be tagged using [Semantic Versioning](https://semver.org/). Candidates will continue to be tagged using the current convention which denotes the difference between developer, alpha and beta releases. Additionally, we will need to use a convention to avoid tag name collisions between iOS and macOS products. macOS releases will be suffixed with "mac-" and iOS releases will be suffixed with "ios-". (See the above diagram for examples.)
|
||||
Each release should be tagged using [Semantic Versioning](https://semver.org/). Candidates will continue to be tagged using the current convention which denotes the difference between developer, alpha and beta releases. Additionally, we will need to use a convention to avoid tag name collisions between iOS and macOS products. macOS releases will be suffixed with "mac-" and iOS releases will be suffixed with "ios-". (See the above diagram for examples.)
|
||||
|
||||
## Packages
|
||||
|
||||
NetNewsWire uses Swift Packages to manage project dependencies. All the packages are under the same project umbrella as NetNewWire and there are no third party dependencies to manage. These packages are mostly stable at this point. For simplicity sake, all development on the packages will continue on their repository Main branch. These packages won’t be managed as separate projects with separate releases/tags at this time.
|
||||
NetNewsWire uses Swift Packages to manage project dependencies. All the packages are under the same project umbrella as NetNewWire and there are no third-party dependencies to manage. These packages are mostly stable at this point. For simplicity’s sake, all development on the packages will continue on their repository Main branch. These packages won’t be managed as separate projects with separate releases/tags at this time.
|
||||
|
||||
## Summary
|
||||
|
||||
|
|
|
|||
|
|
@ -5,39 +5,26 @@ First thing: don’t send money. This app is [written for love](https://inessent
|
|||
NetNewsWire is all about three things:
|
||||
|
||||
* The open web
|
||||
* High-quality open source Mac and iOS apps
|
||||
* High-quality open-source Mac and iOS apps
|
||||
* The community that loves both of the above
|
||||
|
||||
Supporting all these things takes *work*.
|
||||
|
||||
### Here are some things you can do
|
||||
|
||||
In no particular order…
|
||||
In no particular order …
|
||||
|
||||
Write a blog instead of posting to Twitter or Facebook. (You can always re-post to those places if you want to extend your reach.) [Micro.blog](https://micro.blog/) is one good place to get going, but it’s not the only one.
|
||||
|
||||
Use an RSS reader even if it’s not NetNewsWire. (There are a bunch of good ones!)
|
||||
|
||||
Teach other people to use RSS readers. Blog about RSS readers. And about other open web technologies and apps.
|
||||
|
||||
Suggest apps for [macopenweb.com](https://macopenweb.com/).
|
||||
|
||||
Write Mac and iOS apps that promote use of the open web.
|
||||
|
||||
Donate to charities that promote literacy.
|
||||
|
||||
Tell other people about cool blogs and feeds you’ve found.
|
||||
|
||||
Support indie podcast apps.
|
||||
|
||||
Vote for candidates whose policies are not cruel.
|
||||
|
||||
Support your local library.
|
||||
|
||||
Be bold and do your best work.
|
||||
|
||||
Support indie developers — pay for apps that cost money. Even though NetNewsWire is free, apps are most definitely *not* free to make, and it costs money to keep improving them. It’s worth it.
|
||||
|
||||
Finally: report bugs and make feature requests on our Issues tracker. You can also join the Slack group — it’s not just for coders. We also need testers, writers, and, especially, people who are willing to talk things over. Most of software development is just making decisions, and we appreciate all the help we can get!
|
||||
|
||||
Or: skip helping us, and, instead, help people who need help more than we do. Those people should not be hard to find.
|
||||
* Write a blog instead of posting to Twitter or Facebook. (You can always re-post to those places if you want to extend your reach.) [Micro.blog](https://micro.blog/) is one good place to get going, but it’s not the only one.
|
||||
* Use an RSS reader even if it’s not NetNewsWire. (There are a bunch of good ones!)
|
||||
* Teach other people to use RSS readers. Blog about RSS readers. And about other open web technologies and apps.
|
||||
* Suggest apps for [macopenweb.com](https://macopenweb.com/).
|
||||
* Write Mac and iOS apps that promote use of the open web.
|
||||
* Donate to charities that promote literacy.
|
||||
* Tell other people about cool blogs and feeds you’ve found.
|
||||
* Support indie podcast apps.
|
||||
* Vote for candidates whose policies are not cruel.
|
||||
* Support your local library.
|
||||
* Be bold and do your best work.
|
||||
* Support indie developers — pay for apps that cost money. Even though NetNewsWire is free, apps are most definitely *not* free to make, and it costs money to keep improving them. It’s worth it.
|
||||
* Finally: report bugs and make feature requests on our Issues tracker. You can also join the Slack group — it’s not just for coders. We also need testers, writers, and, especially, people who are willing to talk things over. Most of software development is just making decisions, and we appreciate all the help we can get!
|
||||
* Or: skip helping us, and, instead, help people who need help more than we do. Those people should not be hard to find.
|
||||
|
|
|
|||
Loading…
Reference in New Issue