You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributions.md
+38-55Lines changed: 38 additions & 55 deletions
Original file line number
Diff line number
Diff line change
@@ -5,90 +5,73 @@ icon: material/handshake
5
5
6
6
# :material-handshake: Contribution Guidelines
7
7
8
-
This page provides guidelines on how to contribute to Atlas. All contributions are much appreciated!
8
+
This page provides guidelines on how to contribute to Atlas. We highly appreciate your contributions!
9
9
10
-
Atlas uses Git to manage everything on the platform [:simple-github: GitHub](https://github.com/Atlas-OS). To more easily interact with Git, you can use:
10
+
Atlas uses [:simple-github: GitHub](https://github.com/Atlas-OS)to manage everything. See the [GitHub quick start guide](https://docs.github.com/get-started/quickstart) first if you're unfamiliar with GitHub. Apart from how to use GitHub, this page tells you everything else.
11
11
12
-
* An IDE like [:simple-visualstudiocode: Visual Studio Code](https://code.visualstudio.com/) or [:simple-vscodium: VSCodium](https://vscodium.com)
Alternatively, you can use the [:simple-git: Git](https://git-scm.com/) command-line. Use whichever Git interface you find most familiar and easiest. Before contributing, you should [research](https://docs.github.com/en/get-started/quickstart) about Git first.
14
+
### **Atlas Playbook**
16
15
17
-
## :octicons-git-commit-24: How you can contribute
* Read AME Wizard's [:material-file-document: Documentation](https://docs.ameliorated.io/developers.html) for help.
20
+
This repository contains Atlas' central source code, a Playbook file (`.apbx`) used with AME Wizard. It contains all the various scripts, configurations, and more that Atlas applies to people's systems.
22
21
23
-
*[:material-language-rust: **Atlas Utilities**](https://github.com/Atlas-OS/Atlas-Utilities) - General tools used in Atlas like `filepicker.exe`, made in Rust.
* Read [this](https://github.com/Atlas-OS/docs/blob/master/.github/CONTRIBUTING.md) documentation-specific contribution guide for help.
24
+
Consider using virtualisation software like [VMWare Workstation](https://www.vmware.com/products/desktop-hypervisor.html) or [Hyper-V](https://learn.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v) to test. You can use 7-Zip or the included `src\playbook\local-build.cmd` script to build your Playbook.
29
25
30
-
These are the three main repositories to contribute to. There might also may be other repositories that fits your expertise. [Check out our GitHub organisation](https://github.com/Atlas-OS).
26
+
### **Atlas Documentation**
31
27
32
-
If a repository has a specified template for pull requests or issues, please use them. Otherwise, the maintainers reserve the right to close and lock your issue without further response.
The website that you are looking at. We made the Atlas documentation in [MkDocs Material](https://squidfunk.github.io/mkdocs-material/), a documentation framework that uses markdown.
35
32
36
-
Each repository has a `dev` branch and a `main` or `master` branch for development.
33
+
See the repository on how to get started contributing.
37
34
38
-
!!! warning
39
-
Make **all of your changes** to the `dev` branch of the respective repositories!
35
+
## :octicons-issue-closed-24: How our GitHub Issues work
40
36
41
-
Never commit or pull request directly to the `main` branches.
37
+
For transparency with users, we keep issues that affect the current release open and label them with the **fixed next release**.
42
38
43
-
The `dev` branch exists to ensure that only approved and high-quality changes are merged into the `main` branch.
39
+
## :octicons-git-pull-request-24: How to make changes
44
40
45
-
A pull request **every week** will be automatically created to merge the `dev` branch into the `main` branch, where the changes can be properly reviewed by **5 contributors** before the pull request is merged. The only exclusion to having less than 5 reviews is if there's not enough people reviewing, e.g. 4 reviews for documentation.
41
+
!!! tip "Unsure if people like your change?"
42
+
Consider proposing the change to people in the [:simple-discord: Discord](https://discord.gg/atlasos) or [:octicons-issue-opened-16: GitHub issues](https://github.com/Atlas-OS/Atlas/issues) first.
43
+
44
+
Regardless, remember that it's okay to make mistakes. People will give feedback in your pull requests anyways; don't worry about it too much.
46
45
47
-
This ensures that all changes are thoroughly reviewed and agreed upon collectively, resulting in fewer bugs, improved code quality, and a more organized development process.
48
46
49
-
You will have to make your own fork of the respective Atlas repository, and then make a pull request to merge your modified fork's branch into the `dev` branch.
47
+
1. Make a fork, or for team members, a branch in the repository
48
+
1. Make your changes, then make a pull request to the primary branch of the repository
49
+
1. Wait for at least two reviews, **depending on the size of the change**
50
+
- For team members, we only require one review
51
+
1. When it's merged, it will be squash-merged into the primary branch of the repository
52
+
- This means all commits from the branch will be combined into one
50
53
51
-
### :material-git: People with write access
52
-
53
-
!!! note
54
-
This only applies to people with direct access to commit to the repositories, without the need to do a pull request.
55
-
56
-
This list is from our [GitHub organisation's member list](https://github.com/orgs/Atlas-OS/people).
57
-
58
-
For any significant changes, consider creating a pull request for the `dev` branch instead of committing directly.
59
-
60
-
This means less potential headache in the future if the change is disagreed upon, as you can avoid reverting all of the disliked changes for the automatic pull request every week.
61
-
62
-
If you want to, you can also manually trigger the automatic pull request to merge `dev` into `main` early, but the 5 reviews will still be in effect. As a note, if you need to urgently fix something, you can use the `bypass` label to bypass your pull request being automatically closed by the pull request filter.
63
-
64
-
For regular pull requests, you can make your own branch in the Atlas repository or make a fork, it is your choice.
54
+
The only exclusion to this is when there is an urgent change, which team members might directly commit to the primary branch of a repository.
65
55
66
56
## :material-format-letter-case: Formatting
67
57
68
-
Before each commit, ensure that:
58
+
Before a pull request, ensure that:
69
59
70
-
* Your changes comply with the overall formatting of a repository
71
-
* There are the most minimal amount of mistakes, check grammar and anything else important
72
-
* For any YAML change, please verify that it is valid before committing with [YAML Lint](https://www.yamllint.com/).
73
-
* People would generally agree with the change
74
-
* If you don't know, ask people in the [:simple-discord: Discord](https://discord.gg/atlasos) or [:octicons-issue-opened-16: GitHub issues](https://github.com/Atlas-OS/Atlas/issues).
75
-
76
-
Making sure that your commits are already to a high standard means that development will be faster and more organized. However, keep in mind that it's okay to make mistakes sometimes, as people will give feedback/reviews in your pull requests, so don't worry about it too much.
60
+
- Your changes comply with the general formatting of a repository
61
+
- There's a minimal amount of mistakes; check grammar and anything else important
62
+
- For YAML changes, verify that they are valid using a linter
We highly recommend setting up [commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification). This marks your commits as 'Verified', indicating they come from a trusted source.
80
65
81
-
You can install [:simple-gnuprivacyguard: GPG](https://gnupg.org/) (used for signing) in Windows with [Scoop](https://scoop.sh/) with the following command:
82
-
```
83
-
scoop install gpg
84
-
```
85
-
Check out this [detailed guide on setting up verified commits](https://gist.github.com/Beneboe/3183a8a9eb53439dbee07c90b344c77e#file-how-to-setup-verified-commits-md).
66
+
We highly recommend setting up [commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification). This marks your commits as **:material-checkbox-marked-circle: Verified**, indicating commits have not been forged by someone else.
67
+
68
+
Check out this [detailed guide on setting up verified commits](https://gist.github.com/Beneboe/3183a8a9eb53439dbee07c90b344c77e#file-how-to-setup-verified-commits-md). You can install [:simple-gnuprivacyguard: GPG](https://gnupg.org/) (used for signing) in Windows with [Scoop](https://scoop.sh/): `scoop install gpg`
86
69
87
70
### :octicons-git-branch-16: Conventional Commits
88
71
89
-
We recommend using [:simple-conventionalcommits: Conventional Commits](https://www.conventionalcommits.org/) in Atlas repositories for consistency and more descriptive commits. You can also take a look at [Angular's Conventional Commits](https://github.com/angular/angular/blob/68a6a07/CONTRIBUTING.md#commit) for more guidance.
72
+
We recommend using [:simple-conventionalcommits: Conventional Commits](https://www.conventionalcommits.org/) in Atlas repositories for consistency and more descriptive commits. You can also look at [Angular's Conventional Commits](https://github.com/angular/angular/blob/68a6a07/CONTRIBUTING.md#commit) for more guidance.
90
73
91
-
Conventional Commits are a type of commit message format that helps to make the commit history more readable and easier to navigate.
74
+
Conventional Commits are a commit message format that helps to make the commit history more readable and easier to navigate.
0 commit comments