From 8f596cc6f1a583f24b2c01853fea1e0231c0e401 Mon Sep 17 00:00:00 2001 From: Jakub Panek Date: Sun, 8 Oct 2023 22:39:17 +0100 Subject: [PATCH] Remove unnecessary document (#2658) * Remove unnecessary document * Remove dev contributing file --- docs/new-contributor-guide-developer.md | 23 ----------------------- docs/new-contributor-guide-user.md | 23 ----------------------- 2 files changed, 46 deletions(-) delete mode 100644 docs/new-contributor-guide-developer.md delete mode 100644 docs/new-contributor-guide-user.md diff --git a/docs/new-contributor-guide-developer.md b/docs/new-contributor-guide-developer.md deleted file mode 100644 index 59c3d9a3..00000000 --- a/docs/new-contributor-guide-developer.md +++ /dev/null @@ -1,23 +0,0 @@ -# New Contributor Guide **Developers** - -This document contains some useful resources for anyone wishing to contribute to the Lapce project by contributing code. - -## Quick Start - -1. Get an overview of the architecture from [`docs/why-lapce.md`](why-lapce.md) and [Architecture](https://docs.lapce.dev/development/architecture). - -2. Explore the rope data structure, a key part of Lapce's architecture. The crate used is [xi_rope](https://crates.io/crates/xi-rope). - -3. Review both open and closed [issues](https://github.com/lapce/lapce/issues), there may be others working on a similar feature. - -4. [Get cracking](https://dictionary.cambridge.org/dictionary/english/get-cracking)! - -5. Be aware that unless you explicitly state otherwise, contributions you make to this project will be under the Apache License Version 2. - -## Resources - -The [Wikipedia article on ropes](https://en.wikipedia.org/wiki/Rope_(data_structure)) provides an overview of the data structure. - -For some context, also see [Ropes: an Alternative to Strings](https://www.cs.tufts.edu/comp/150FP/archive/hans-boehm/ropes.pdf) by Boehm, Atkinson, and Plass. - - diff --git a/docs/new-contributor-guide-user.md b/docs/new-contributor-guide-user.md deleted file mode 100644 index 84d9cdc1..00000000 --- a/docs/new-contributor-guide-user.md +++ /dev/null @@ -1,23 +0,0 @@ -# New Contributor Guide **Users** - -This document contains some useful resources for anyone wishing to contribute to the Lapce project by suggesting improvements, requesting features, or supporting the community. Where it says _question_ in this document, it can also apply to _suggestions_, _requests_, etc. - -## Quick Start - -1. Open a text editor - -2. Write out your question (or request, or suggestion). - -3. _Revise_ your question - -4. Choose where to post your question - -5. Post it! - -## Resources - -For general information about open source software, [see these FAQs](https://opensource.org/faq) by the Open Source Initiative. - -We don't have a specified code of conduct yet, but for some reasonable guidelines see the [Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/). - -[This guide](http://www.catb.org/~esr/faqs/smart-questions.html), by Eric Steven Raymond, is about how to ask excellent questions. You can apply the same techniques (such as _Use meaningful, specific subject headers_) to suggestions and bug reports. The more specific (and helpful!) you can be with your question, the more it helps us to provide a solution.