solene
/
openbsd-webzine
6
0
Fork 8
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity
openbsd-webzine/README.md

86 lines
2.3 KiB
Markdown
Raw Normal View History

Initial commit
2021-09-26 18:45:48 +00:00
# openbsd-webzine
yolo
2021-09-26 19:27:05 +00:00
Repository of the OpenBSD Webzine
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
# Workflow
yolo
2021-09-26 19:27:05 +00:00
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
Everything related to writing a new issue is under `issues` directory.
yolo
2021-09-26 19:27:05 +00:00
## New issue
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
- copy `_template` directory under a name like `issue-X` with `X` being the new issue number
- delete the symlink `current` and recreate it with the new issue as the target
yolo
2021-09-26 19:27:05 +00:00
Minor Markdown improvements
2021-10-01 00:22:40 +00:00
I.e.
```
$ cd issues
$ cp -r _template issue-3
$ ln -fs issue-3 current
```
yolo
2021-09-26 19:27:05 +00:00
## Edit an issue
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
- cd into `issues/current/` and edit files as needed
- categories that are empty should be commented out using HTML comments
- when you recreate the issues with `make`, the one in development is generated in `../dev/`
- use `make test` to automatically copy the current issue to `/tmp/openbsd-webzine` directory and open it in a web browser
How to contribute
2021-09-26 21:58:38 +00:00
# Contributing
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
Anyone can contribute by doing the following:
How to contribute
2021-09-26 21:58:38 +00:00
- English proofreading
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
- translation into other languages
- content contribution
How to contribute
2021-09-26 21:58:38 +00:00
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
There are many ways to contribute - here is a list by order of preference (easier to handle):
How to contribute
2021-09-26 21:58:38 +00:00
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
1. make an account on tildegit, fork the project, create a new branch with changes, and send us Pull Requests (it's easy once you get how this work - see "Git usage" below)
Minor Markdown improvements
2021-10-01 00:22:40 +00:00
2. make a local commit from a freshly updated cloned repository and use `git format-patch` to send an email to a contributor (currently _solene_) so your commit can be merged into the repository easily
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
3. send a simple diff to a contributor
4. open an issue
5. speak on IRC / XMPP / email
Content
2021-09-27 06:54:42 +00:00
# What content?
For each issue we will try to write about these topics:
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
- job offers related to OpenBSD (if any)
Minor Markdown improvements
2021-10-01 00:22:40 +00:00
- big changes landing in _-current_
- syspatch and digest of package updates in _-stable_
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
- interviews with developers or professionals using OpenBSD (if any)
Content
2021-09-27 06:54:42 +00:00
- tips about shell or OpenBSD
- comments from readers
- links to OpenBSD content
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
- a piece of artwork
- a few interesting links to social media
Content
2021-09-27 06:54:42 +00:00
add git usage instruction to contribute
2021-09-28 08:02:16 +00:00
## Git usage
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
Fork this project and clone your own fork, then add the upstream repo.
add git usage instruction to contribute
2021-09-28 08:02:16 +00:00
```
$ git clone git@tildegit.org:foo/openbsd-webzine.git
$ cd openbsd-webzine
$ git remote add upstream https://tildegit.org/solene/openbsd-webzine.git
```
Keep your fork sync with upstream.
```
$ git pull upstream main
```
You can now edit files.
Improve the language While there, make sure lists are consistent - items start with a lowercase letter and do *not* end with a full stop ('.').
2021-10-01 00:11:00 +00:00
At last, add modified files and commit:
add git usage instruction to contribute
2021-09-28 08:02:16 +00:00
```
$ git add issue-*/
$ git commit -m "message"
$ git push
```
"Merge Request" is a GitLab term
2021-10-01 00:15:29 +00:00
You can now ask for your Pull Request to get merged.