tyler.durden
/
bottom
mirror of https://github.com/ClementTsang/bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
bottom/CONTRIBUTING.md

43 lines
2.5 KiB
Markdown
Raw Normal View History

docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
# Contribution
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 07:40:58 +02:00
Contribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc.
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 07:40:58 +02:00
## Opening an issue
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 07:40:58 +02:00
### Bug reports
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
docs: update contributing docs/links
2023-02-13 09:35:46 +01:00
When filing a bug report, use the [bug report template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=bug&template=bug_report.yml&title=%5BBug%5D+)
docs: change wording slightly for bug report contribution (#613) Small wording updates for what is expected from bug reports.
2021-11-27 12:42:55 +01:00
and fill in as much as you can. It is _incredibly_ difficult for a maintainer to fix a bug when it cannot be reproduced,
and giving as much detail as possible generally helps to make it easier to reproduce the problem!
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 07:40:58 +02:00
### Feature requests
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
docs: update contributing docs/links
2023-02-13 09:35:46 +01:00
Please use the [feature request template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=feature&template=feature_request.yml&title=%5BFeature%5D+) and fill it out.
docs: update some contribution documentation
2022-09-16 11:16:58 +02:00
Remember to give details about what the feature is along with why you think this suggestion will be useful.
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
## Pull requests
docs: tweak wording in README and CONTRIBUTING
2021-10-18 03:44:19 +02:00
If you want to directly contribute documentation changes or code, follow this! The expected workflow for a pull request is:
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
docs: migrate documentation over to mkdocs (#506) A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
2021-06-21 07:40:58 +02:00
1. Fork the project.
docs: update some contribution documentation
2022-09-16 11:16:58 +02:00
2. Make your changes.
docs: update contributing docs/links
2023-02-13 09:35:46 +01:00
3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/) for tips on documentation.
4. Commit and create a pull request to merge into the `master` branch. **Please fill out the pull request template**.
5. Ask a maintainer to review your pull request.
- Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a
first-time contributor, you may need to wait for a maintainer to let CI run.
docs: update some contribution documentation
2022-09-16 11:16:58 +02:00
- If changes are suggested or any comments are made, they should probably be addressed.
docs: update contributing docs/links
2023-02-13 09:35:46 +01:00
6. Once it looks good, it'll be merged! Note that _generally_, PRs are squashed to maintain repo cleanliness, though
feel free to ask otherwise if that isn't preferable.
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
docs: revert CFP for now (#633) There were some weird interactions that I'm not sure about (like if you do bottom.pages.dev/asdf/ it infinitely redirects...?), so I'll revert for now.
2021-12-19 21:42:22 +01:00
For more details, see [here](https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/).
docs: Add CONTRIBUTING.md
2020-04-29 04:54:50 +02:00
docs: more contribution doc stuff
2021-10-20 00:29:59 +02:00
### Documentation
docs: revert CFP for now (#633) There were some weird interactions that I'm not sure about (like if you do bottom.pages.dev/asdf/ it infinitely redirects...?), so I'll revert for now.
2021-12-19 21:42:22 +01:00
For contributing to documentation, see [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/).
docs: more contribution doc stuff
2021-10-20 00:29:59 +02:00
### Packaging
docs: update contributing docs/links
2023-02-13 09:35:46 +01:00
If you want to become a package maintainer, see [here](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/)
for details on how to build bottom, corresponding completion/manpages, and how to add installation instructions for the package to the README.