aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.md94
-rw-r--r--README.md7
2 files changed, 87 insertions, 14 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d450c7d..c331bf9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,7 +24,7 @@ I will reject all contributions from:
24 24
25Furthermore, individual items will be rejected because of: 25Furthermore, individual items will be rejected because of:
26- exceptionally vulgar language. 26- exceptionally vulgar language.
27- ignorance or disregard of the `STYLE_GUIDE.md` or Issue/PR templates. 27- ignorance or disregard of the `STYLE_GUIDE.md` or Issue templates.
28 28
29 29
30## How to Contribute 30## How to Contribute
@@ -32,13 +32,13 @@ Furthermore, individual items will be rejected because of:
32There are several ways you can contribute. 32There are several ways you can contribute.
33 33
34The easiest way you can contribute is by taking part in the discussions 34The easiest way you can contribute is by taking part in the discussions
35on the [GitHub Issues page](https://github.com/MountainMan1312/MMOSMacs/Issues). 35on the [GitHub Issues page](https://github.com/MountainMan1312/MMOSMacs/issues).
36You can comment on topics that already have an existing Issue, or you 36You can comment on topics that already have an existing Issue, or you
37can submit your own if it does not already exist. Issues can take the 37can submit your own if it does not already exist. Issues can take the
38form of: 38form of:
39- **Feedback**: share your thoughts about MMOSMacs.
40- **Bug Report**: discusion about a problem with the MMOSMacs code.
41- **RFC**: discussion about making a change to MMOSMacs. 39- **RFC**: discussion about making a change to MMOSMacs.
40- **Bug Report**: discusion about a problem with the MMOSMacs code.
41- **Feedback**: share your thoughts about MMOSMacs.
42 42
43Before submitting a new issue, search for existing duplicate issues. If 43Before submitting a new issue, search for existing duplicate issues. If
44it already exists, comment on the existing Issue instead of making a new 44it already exists, comment on the existing Issue instead of making a new
@@ -46,12 +46,86 @@ one. Duplicate issues will be removed and you will be asked to move your
46post to the comment section of the existing post. It's not to be rude, 46post to the comment section of the existing post. It's not to be rude,
47it's just for organization's sake. 47it's just for organization's sake.
48 48
49Each type of Issue has an Issue Template. The templates can be found in
50the `.github/ISSUE_TEMPLATE/` directory. Pull reqeusts also have
51templates which are located in `.github/PULL_REQUEST_TEMPLATE/`.
52
53To contribute code: 49To contribute code:
541. Make an RFC or find an existing one 501. Make an RFC or find an existing one
552. Discuss your proposed changes 512. Discuss your proposed changes
563. Make your changes 523. Create a branch
574. Submit a Pull Request 534. Make your changes
545. Submit a Pull Request
55
56
57### RFC Issues, branches, commits, & Pull Requests
58
59#### Writing an RFC
60
61RFCs are the main form of project management for this repository. All
62major changes to MMOSMacs should have an associated RFC. RFC Issues
63should be named in the format `RFC: TITLE`, where title is a short
64description of the proposed changes. For example, the RFC to modify a
65few default Emacs things as a starting point for MMOSMacs is called
66`RFC: Start with sensible defaults`.
67
68The following template should be used when writing an RFC.
69
70```markdown
71# Summary
72
73Provide a one-paragraph summary of the proposed changes
74
75
76# Rationale and motivation
77
78Explain why this change is necessary or desirable. Relate to any other
79relevant RFCs, Bug Reports, or Feedback. Feel free to link to Issues
80from other repositories as well.
81
82
83# Details
84
85Provide an in-depth description of your proposed changes. This should
86get into specifics and corner-cases.
87
88
89# Drawbacks and Alternatives (optional)
90
91Why should these changes NOT be implemented? What other options are
92there, and why are these changes better than the alternatives?
93
94
95# Additional resources (optional)
96
97Link to external resources such as research papers, images, etc.
98
99
100# Unresolved questions (optional)
101
102Ask any further questions you have.
103```
104
105
106#### Creating branches & committing changes
107
108All changes made as part of an RFC should be made in an associated
109branch. The branch should be named in the format `TYPE/#/TITLE`, where
110TYPE is one of `RFC, BUG`, X is the Issue number, and TITLE is a short
111summary of the RFC title. For example the branch for
112`RFC: Start with sensible defaults` is named `RFC/2/sensible-defaults`.
113Branch names should be short, with an absolute maximum of 72 characters
114(preferrably shorter).
115
116Commits should be small and nuclear. They should each do "one thing".
117That said, multiple files could theoretically be affected by a single
118commit. Commit messages should be brief, but not omit any necessary
119detail.
120
121
122#### Writing a Pull Request
123
124Like RFCs, all major changes to MMOSMacs must have an associated Pull
125Reqest, which explains in detail the changes that were made. Pull
126Requests are reviewed before the changes are accepted into the stable
127branch, and it is likely that the reviewer will reject your changes with
128notes on what needs to be fixed.
129
130Pull Requests should explain the specifics and nuances of the changes
131contained therein.
diff --git a/README.md b/README.md
index 4a9bfdb..e1d81d0 100644
--- a/README.md
+++ b/README.md
@@ -5,12 +5,10 @@ idea I have for an Emacs-centric Linux distribution. MMOSMacs is the
5core of my computing experience, and is designed to be a 5core of my computing experience, and is designed to be a
6jack-of-all-trades just like me. 6jack-of-all-trades just like me.
7 7
8MMOSMacs is currently in the planning phase.
9
10 8
11## Plans 9## Plans
12 10
13- Modular non-literate configuration 11- Non-literate configuration
14- `straight.el` + `use-package` package management 12- `straight.el` + `use-package` package management
15- Emacs as a desktop environment (`EXWM`, `EDNC`) 13- Emacs as a desktop environment (`EXWM`, `EDNC`)
16- System & network administration suite 14- System & network administration suite
@@ -26,7 +24,8 @@ MMOSMacs is currently in the planning phase.
26 - Games 24 - Games
27- Custom modeline & anti-distraction features 25- Custom modeline & anti-distraction features
28- Custom theme deisnged to reduce eye-strain 26- Custom theme deisnged to reduce eye-strain
29- Custom keybinds, menus, & dialogs 27- Custom keybind system, menus, & dialogs
28
30 29
31## Contributing 30## Contributing
32 31