Macintosh-Tools/mlvwm
1
0
Fork 0
mirror of https://github.com/morgant/mlvwm.git synced 2024-11-21 10:31:50 +00:00
Code Issues Projects Releases Wiki Activity

Added initial CONTRIBUTING.md and linked to from README.md. Issue #14

Browse Source
This commit is contained in:
Morgan Aldridge 2021-03-25 09:05:41 -04:00
parent 9aaa7f42a6
commit 7bbc1f1bde
2 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,37 @@
# Contributing to MLVWM
We welcome feedback, bug fixes, and feature request. Ultimately, what gets accepted and merged into the project is up to the current project maintainer ([Morgan Aldridge](https://github.com/morgant)) and what they feel is appropriate for all users of the project, but you are encouraged to submit any suggestions.
Please submit bugs and feature requests via the project’s [issue tracker](https://github.com/morgant/mlvwm/issues).
## What You Need
You will need the following to contribute:
* A [GitHub](http://github.com) account for submitting pull requests
* X11
## Making Changes
Follow these steps when making changes. That way, they will most likely be accepted with few headaches and very little back and forth.
1. Fork the [mlvwm](https://github.com/morgant/mlvwm) project on GitHub.
2. Create a topic branch from the `master` branch. Name your branch appropriately, reflecting the intended changes (e.g. “sprintf-to-snprintf” or “scroll-bar-theme-improvements”)
3. Make your edits (please try to conform to our [style guide](#style-guide)).
4. Make commits in logical units and with concise but explanatory commit messages. Please reference any appropriate issue numbers, e.g. "Issue #16".
5. Ensure your changes build without additional warnings or errors. We suggest testing in `Xephyr`.
## Submitting Changes
When you’ve completed your changes and are ready to merge them into the main project, follow these steps to submit them for review.
1. Push the changes to your fork of the [mlvwm](https://github.com/morgant/mlvwm) project on GitHub
2. Submit a pull request to the [mlvwm](https://github.com/morgant/mlvwm) project
That’s all there is to it.
If you followed the [making changes](#making-changes) guidelines and the changes are aligned with the vision of the project, it should be a smooth process to merge them.
## Style Guide
This is a very old codebase from before syle guides were a thing and we haven't yet tackled standardizing the formatting. So, for the time being, please try to use the same style as surrounding code, including either spaces or tabs for indendation (whichever is used locally), spacing around parentheses, etc. Please remove any trailing whitespace from lines.

4
README.md
View File

@ -56,6 +56,10 @@ We suggest reading the manual page (`man mlvwm`; English), but you may also find
Note: the English documentation above was automatically generated from the Japanese documentation.
## CONTRIBUTING
Contributions are welcome and appreciated. Please read and follow the [CONTRIBUTING](CONTRIBUTING.md) guidelines.
## HISTORY
MLVWM was originally developed in 1997 by Takashi HASEGAWA, based on FVWM, while studying at Nagoya University. Active development proceeded through 2000. In 2020, Morgan Aldridge obtained permission to continue maintenance & development.