removed CHANGELOG for now and added some more details
This commit is contained in:
henil
parent
aa8da0b142
commit
c906a8b2fa
2 changed files with 59 additions and 17 deletions
|
|
@ -2,31 +2,69 @@
|
|||
|
||||
Thanks for considering to contribute to mosaic!
|
||||
|
||||
**First**: if you're unsure or afraid of anything, just ask on our
|
||||
[Discord server](discord-invite-link) or submit the issue or pull request anyway.
|
||||
You won't be yelled at for giving it your best effort. The worst that can happen
|
||||
is that you'll be politely asked to change something. We appreciate any sort
|
||||
of contributions, and don't want a wall of rules to get in the way of that.
|
||||
|
||||
# Code of Conduct
|
||||
|
||||
Before contributing please read our [Code of Conduct](CODE_OF_CONDUCT.md) which
|
||||
all contributors are expected to adhere to.
|
||||
|
||||
## Add an entry to the changelog
|
||||
## Looking for something to work on?
|
||||
|
||||
If your contribution changes the behavior of `mosaic` (as opposed to a typo-fix
|
||||
in the documentation), please update the [`CHANGELOG.md`](CHANGELOG.md) file
|
||||
and describe your changes. This makes the release process much easier and
|
||||
therefore helps to get your changes into a new `mosaic` release faster.
|
||||
If you are new contributor to `Mosaic` going through [beginners](good-first-issue)
|
||||
should be a good start or you can join our public
|
||||
[Discord server](discord-invite-link), we would be happy to help
|
||||
finding something interesting to work on and guide through.
|
||||
|
||||
The top of the `CHANGELOG` contains a *"unreleased"* section with a few
|
||||
subsections (Features, Bugfixes, …). Please add your entry to the subsection
|
||||
that best describes your change.
|
||||
[discord-invite-link]: https://discord.gg/feHDHahHCz
|
||||
[good-first-issue]: https://github.com/mosaic-org/mosaic/labels/good%20first%20issue
|
||||
|
||||
Entries follow this format:
|
||||
```
|
||||
- Short description of what has been changed, see #123 (@user)
|
||||
```
|
||||
Here, `#123` is the number of the original issue and/or your pull request.
|
||||
Please replace `@user` by your GitHub username.
|
||||
## Filing Issues
|
||||
|
||||
## Lacking API for plugin in mosaic
|
||||
Bugs and enhancement suggestions are tracked as GitHub issues.
|
||||
|
||||
#### Lacking API for plugin in mosaic?
|
||||
|
||||
If you have a plugin idea, but mosaic still doesn't have API required to make
|
||||
the plugin consider opening [an issue][plugin-issue] and describing your
|
||||
requirements.
|
||||
the plugin consider opening [an issue][plugin-issue] and describing your requirements.
|
||||
|
||||
[plugin-issue]: https://github.com/mosaic-org/mosaic/issues/new?assignees=&labels=plugin%20system
|
||||
|
||||
#### How Do I Submit A (Good) Bug Report?
|
||||
|
||||
After you've determined which repository your bug is related to and that the
|
||||
issue is still present in the latest version of the master branch, create an
|
||||
issue on that repository and provide the following information:
|
||||
|
||||
- Use a **clear and descriptive title** for the issue to identify the problem.
|
||||
- Explain which **behavior you expected** to see instead and why.
|
||||
- Describe the exact **steps to reproduce the problem** in as many details as necessary.
|
||||
- When providing code samples, please use [code blocks](code-blocks).
|
||||
|
||||
#### How Do I Submit A (Good) Enhancement Suggestion?
|
||||
|
||||
Instructions are similar to those for bug reports. Please provide the following
|
||||
information:
|
||||
|
||||
- Use a **clear and descriptive title** for the issue to identify the suggestion.
|
||||
- Provide a **description of the suggested enhancement** in as many details as necessary.
|
||||
- When providing code samples, please use [code blocks](code-blocks).
|
||||
|
||||
[code-blocks]: https://help.github.com/articles/creating-and-highlighting-code-blocks/
|
||||
|
||||
## Submitting Pull Requests
|
||||
|
||||
Instructions are similar to those for bug reports. Please provide the following information:
|
||||
|
||||
- If this is not a trivial fix, consider **creating an issue to discuss first** and **later link to it from the PR**.
|
||||
- Use a **clear and descriptive title** for the pull request.
|
||||
- Provide a **description of the changes** in as many details as necessary.
|
||||
|
||||
Before submitting your pull request, also make sure that the following conditions are met:
|
||||
|
||||
- Your new code **adheres to the code style** through running `cargo fmt`.
|
||||
- Your new code **passes all existing and new tests** through running `cargo test`.
|
||||
|
|
|
|||
|
|
@ -100,6 +100,10 @@ This section contains an ever-changing list of the major features that are eithe
|
|||
* <b>Built in support for portable workspaces across machines, projects and teams</b>: imagine being able to include a configuration file with your project that would include all the layouts and plugins that would best help new developers getting onboarded. Including all the shortcuts, customized panes and help-message hints triggered by things such as opening a file, entering a folder or running a command. How about being able to log into a new server or container, start mosaic with a URL of a git repository including your favorite configuration and plugins, and working with it as if you were on your own machine?
|
||||
* <b>Support for multiple terminal windows across screens</b>: Why limit yourself to one terminal window? Mosaic would allow you to transfer panes, view powerlines, get alerts and control your workspace from different windows by having them all belong to the same session.
|
||||
|
||||
# Contributing
|
||||
|
||||
Take a look at [`Contributing.md`](CONTRIBUTING.md) guide.
|
||||
|
||||
# License
|
||||
|
||||
MIT
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue