Loading article content
This project adopts a flat organizational structure. The only two roles are reviewers (admins) and writers (users). Reviewers are rotating among the internal writer team. Other from that, there are no differences between an outside contributor and a writer.
Reviewers will be rotating among the writer team.
Reviewers are responsible for:
Simply clone this repo, stay updated by pulling the latest changes, and submit a merge request with your article. The reviewers will review your article and merge it if:
We don't want to require any git knowledge for contributors. However, to preserve traceability and transparency of the editting history, we still have to enforce some standards on commits.
If you are not familiar with git, don't worry. Our online editor uses Git and Pull Requests as the backend, but most technical details will be hidden from contributors, so most standards can be satisfied effortlessly by simply following the instructions on the website. If you know git and write on your local editor, you might want to read the standards below to make sure your PR can be merged smoothly.
Reviewers should also read these standards and enforce them when reviewing PRs.
Commit messages should be clear and descriptive. Something like Update is not acceptable. A good commit message should be concise yet descriptive enough to understand your changes without looking at the diff.
If applicable, you should follow the scope: subject format, e.g. entity ai: add code walkthrough for the pathfinding algorithm. Try not to exceed 72 characters for the title, you may cramble the rest of the description in the body if necessary.
For a strict linear history on main, all branches should be merged through squash merges, or only very occasionally, rebase merges. A rebase merge might be used for the following scenarios:
Merge commits are strictly prohibited. Do NOT create any of them on your own fork. See Preventing Merge Commits for more instructions on how to avoid creating merge commits. We will revise pull requests to remove merge commits if they contain any.