-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
ADMSK\AVROGAL1
committed
Feb 25, 2021
1 parent
174130d
commit 2bde27b
Showing
6 changed files
with
226 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Contributor License Agreement | ||
|
||
``` | ||
By making a contribution to this project, I certify that: | ||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the LGPLv3 license; or | ||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the LGPLv3 license; or | ||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it) is maintained indefinitely | ||
and may be redistributed consistent with this project or the open | ||
source license(s) involved. | ||
``` | ||
|
||
## Attribution | ||
|
||
The text of this license is available under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/). It is based on the Linux [Developer Certificate Of Origin](http://elinux.org/Developer_Certificate_Of_Origin), but is modified to explicitly use the LGPLv3 license | ||
and not mention sign-off. | ||
|
||
## Signing | ||
|
||
To sign this CLA you must first submit a pull request to a repository under the user account |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## _Ownership_ | ||
|
||
* [https://github.com/AlexRogalskiy/](https://github.com/AlexRogalskiy/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
## Sign your work - the Developer's Certificate of Origin | ||
The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org): | ||
|
||
> Developer's Certificate of Origin 1.1 | ||
> | ||
> By making a contribution to this project, I certify that: | ||
> | ||
> (a) The contribution was created in whole or in part by me and I | ||
> have the right to submit it under the open source license | ||
> indicated in the file; or | ||
> | ||
> (b) The contribution is based upon previous work that, to the best | ||
> of my knowledge, is covered under an appropriate open source | ||
> license and I have the right under that license to submit that | ||
> work with modifications, whether created in whole or in part | ||
> by me, under the same open source license (unless I am | ||
> permitted to submit under a different license), as indicated | ||
> in the file; or | ||
> | ||
> (c) The contribution was provided directly to me by some other | ||
> person who certified (a), (b) or (c) and I have not modified | ||
> it. | ||
> | ||
> (d) I understand and agree that this project and the contribution | ||
> are public and that a record of the contribution (including all | ||
> personal information I submit with it, including my sign-off) is | ||
> maintained indefinitely and may be redistributed consistent with | ||
> this project or the open source license(s) involved. | ||
|
||
#### DCO Sign-Off Methods | ||
|
||
The DCO requires a sign-off message in the following format appear on each commit in the pull request: | ||
|
||
> Signed-off-by: Random J Developer <random@developer.example.org> | ||
|
||
using your real name (sorry, no pseudonyms or anonymous contributions.) | ||
|
||
The DCO text can either be manually added to your commit body, or you can add either **-s** or **--signoff** to your usual git commit commands. If you forget to add the sign-off you can also amend a previous commit with the sign-off by running **git commit --amend -s**. If you've pushed your changes to Github already you'll need to force push your branch after this with **git push -f**. | ||
|
||
|
||
#### Alternative Sign-Off Methods in rare cases | ||
|
||
|
||
If it is really no option for you to disclose your real name and email address, there might be a chance that you can get your contribution accepted. In this case please contact the maintainers directly and verify the adherence to the DCO of the contribution manually. This might include quite some legal overhead for both parties. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# Documentation Style Guide | ||
|
||
## Purpose | ||
|
||
The purpose of this document is to define unified standards and guidelines for contributors to the PostHog Docs. | ||
|
||
As a developer-focused product, PostHog depends on its documentation to provide a good experience to users who wish to use our product. Thus, it is important that our Documentation is complete, concise, and well-written. | ||
|
||
Hence, this guide aims to provide some basic guidelines for those wishing to contribute to the Documentation. | ||
|
||
## Guidelines | ||
|
||
### Golden Rule: Assume Nothing (Almost) | ||
|
||
Assume as little as possible about your reader regarding the topic at hand. Whenever possible, you should provide links to other Docs and pages which describe how to download, update, and debug certain tools, so that your reader can easily solve an issue without having to go out searching on their own. | ||
|
||
Regarding this point, there is a tradeoff. You do not want your text to get too long by teaching your reader how to turn on their laptop (they hopefully have that down), but you do want to instruct them on anything that is **essential** for completing a certain action. | ||
|
||
It is dangerous to assume that because something is obvious to you, it will also be obvious to your reader - just keep that in mind. | ||
|
||
### Additional Suggestions | ||
|
||
**Use American English** | ||
|
||
PostHog is a a global company, with a team distributed across the world. As a result, to keep our communication consistent, we use American spelling for our Documentation. | ||
|
||
**Use the Oxford comma for lists** | ||
|
||
Example: Write "bananas, apples, and oranges", not "bananas, apples and oranges". | ||
|
||
**Capitalize the names of tools, protocols, and technologies** | ||
|
||
Example: Write "Redis server", not "redis server". | ||
|
||
**Capitalize acronyms** | ||
|
||
Example: Write "URLs", not "urls". | ||
|
||
On another note, try to avoid acronyms unless they're so common that it's weird not to. For example, Hyper Text Transfer Protocol is a weird way to say HTTP. | ||
|
||
**Capitalize every word in a title (except for prepositions)** | ||
|
||
Example: Write "Documentation Style Guide" instead of "Documentation style guide". | ||
|
||
"Style Guide **for** Documentation" is fine, however. | ||
|
||
**Adhere to the style standards of each programming language** | ||
|
||
In code snippets, you should follow the conventions of the language the code is written in. | ||
|
||
Example: Use `camelCase` for JavaScript, and `snake_case` for Python variables names. | ||
|
||
**Where there is a Call to Action, always provide a link** | ||
|
||
When you write: "You can contact us to learn more", make sure to provide the reader with the means to do so immediately. This could be a link to another page or an email address, for example. | ||
|
||
Making sure readers always have immediate access to the next suggested step significantly enhances the reading experience. This way, a reader doesn't have to scour the website to find where the hell the link to the Slack group is. | ||
|
||
**Use in-line code for everything that is found somewhere on the code** | ||
|
||
Rule of thumb: If it has an underscore, put a backtick around it. | ||
|
||
Examples: `API_KEY`, `distinct_id`, `reset()`. | ||
|
||
**Avoid repetition of terms** | ||
|
||
Example: "We believe this because we believe …" | ||
|
||
**Avoid `mailto` links** | ||
|
||
They're mostly annoying, not helpful. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
name: Codeowners merging | ||
|
||
on: | ||
pull_request_target: { types: [ opened ] } | ||
issue_comment: { types: [ created ] } | ||
pull_request_review: { types: [ submitted ] } | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v1 | ||
- name: Run Codeowners merge check | ||
uses: OSS-Docs-Tools/code-owner-self-merge@v1 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |