From 830d23e0a1482fd083139a21592150a78f94641f Mon Sep 17 00:00:00 2001 From: Chris Kipp Date: Sat, 19 Feb 2022 21:36:18 +0100 Subject: [PATCH] docs: update links to point to Scala site This just updates some of the links in the README that are still linking to the old Dotty site. This updates them to point towards the new documentation located on the actual Scala site. --- CONTRIBUTING.md | 7 ++----- README.md | 7 +++---- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19af50ebd49f..3267d1f02700 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,14 +12,12 @@ This is the process for committing code to the Scala project. There are of cours 2. The ticket has been discussed and prioritized by the team. 3. You should always perform your work in its own Git branch. The branch should be given a descriptive name that explains its intent. Some teams also like adding the ticket number and/or the [GitHub](http://github.com) user ID to the branch name, these details is up to each of the individual teams. (See below for more details on branch naming.) 4. When the feature or fix is completed you should open a [Pull Request](https://help.github.com/articles/using-pull-requests) on GitHub. -5. The Pull Request should be reviewed by other maintainers (as many as feasible/practical). Note that a reviewer can also be an outside contributor—members of Typesafe and independent contributors are encouraged to participate in the review process. It is not a closed process. Please try to avoid conflict of interest—the spirit of the review process is to evenly distribute the understanding of our code base across its maintainers as well as to load balance quality assurance. Assigning a review to a "sure win" reviewer is not a good long-term solution. +5. The Pull Request should be reviewed by other maintainers (as many as feasible/practical). Note that a reviewer can also be an outside contributor—members of Typesafe or VirtusLab and independent contributors are encouraged to participate in the review process. It is not a closed process. Please try to avoid conflict of interest—the spirit of the review process is to evenly distribute the understanding of our code base across its maintainers as well as to load balance quality assurance. Assigning a review to a "sure win" reviewer is not a good long-term solution. 6. After the review, you should resolve issues brought up by the reviewers as needed (pushing a new commit to address reviewers' comments), iterating until the reviewers give their thumbs up, the "LGTM" (acronym for "Looks Good To Me"). 7. Once the code has passed review the Pull Request can be merged into the distribution. ## Pull Request Requirements -First, please have a look at and follow the [Pull Request Policy](https://github.com/scala/scala/wiki/Pull-Request-Policy) for guidelines on submitting a pull request to the dotty project. (the pull request policy is the same as for the Scala programming language) - In order for a Pull Request to be considered, it has to meet these requirements: 1. Live up to the current code standard: @@ -39,7 +37,7 @@ All contributed code should come accompanied by documentation. Pull requests con It is ok to work on a public feature branch in the GitHub repository. Something that can sometimes be useful for early feedback etc. If so, then it is preferable to name the branch accordingly. This can be done by either prefixing the name with ``wip-`` as in ‘Work In Progress’, or use hierarchical names like ``wip/..``, ``feature/..`` or ``topic/..``. Either way is fine as long as it is clear that it is work in progress and not ready for merge. This work can temporarily have a lower standard. However, to be merged into master it will have to go through the regular process outlined above, with Pull Request, review etc.. -Also, to facilitate both well-formed commits and working together, the ``wip`` and ``feature``/``topic`` identifiers also have special meaning. Any branch labelled with ``wip`` is considered “git-unstable” and may be rebased and have its history rewritten. Any branch with ``feature``/``topic`` in the name is considered “stable” enough for others to depend on when a group is working on a feature. +Also, to facilitate both well-formed commits and working together, the ``wip`` and ``feature``/``topic`` identifiers also have special meaning. Any branch labeled with ``wip`` is considered “git-unstable” and may be rebased and have its history rewritten. Any branch with ``feature``/``topic`` in the name is considered “stable” enough for others to depend on when a group is working on a feature. ## Creating Commits And Writing Commit Messages @@ -60,4 +58,3 @@ Example: - Details 1 - Details 2 - Details 3 - diff --git a/README.md b/README.md index fa564654fb38..1e62e90a1845 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,11 @@ Dotty [![Dotty CI](https://github.com/lampepfl/dotty/workflows/Dotty/badge.svg?branch=master)](https://github.com/lampepfl/dotty/actions?query=branch%3Amain) [![Join the chat at https://discord.com/invite/scala](https://img.shields.io/discord/632150470000902164)](https://discord.com/invite/scala) -* [Homepage](https://dotty.epfl.ch) -* [Documentation](https://dotty.epfl.ch/docs) +* [Documentation](https://docs.scala-lang.org/scala3/) Try it out ========== -To try it in your project see also the [Getting Started User Guide](https://dotty.epfl.ch/#getting-started). +To try it in your project see also the [Getting Started User Guide](https://docs.scala-lang.org/scala3/getting-started.html). Building a Local Distribution ============================= @@ -23,7 +22,7 @@ other more direct lines of communication such as email. How to Contribute ================= -* [Getting Started as Contributor](https://dotty.epfl.ch/docs/contributing/getting-started.html) +* [Getting Started as Contributor](https://docs.scala-lang.org/scala3/guides/contribution/contribution-intro.html) * [Issues](https://github.com/lampepfl/dotty/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) License