summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorKristian Aune <kraune@verizonmedia.com>2023-09-20 16:10:41 +0200
committerKristian Aune <kraune@verizonmedia.com>2023-09-20 16:10:41 +0200
commit5c65fa5021d3fc3ed0c204473e2ef8c1c7f2cef4 (patch)
tree583218e074a4b328e7968d62b57d61fc1d8ac384 /CONTRIBUTING.md
parent09a2a7c21a1ca82a4ca56a449283217fedf8125b (diff)
Fix links and HTML errors
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md40
1 files changed, 20 insertions, 20 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9e18ffbf487..b96c7ee8a60 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,41 +2,41 @@
# Contributing to Vespa
-Contributions to [Vespa](http://github.com/vespa-engine/vespa),
-[Vespa system tests](http://github.com/vespa-engine/system-test),
+Contributions to [Vespa](https://github.com/vespa-engine/vespa),
+[Vespa system tests](https://github.com/vespa-engine/system-test),
[Vespa samples](https://github.com/vespa-engine/sample-apps)
-and the [Vespa documentation](http://github.com/vespa-engine/documentation) are welcome.
+and the [Vespa documentation](https://github.com/vespa-engine/documentation) are welcome.
This documents tells you what you need to know to contribute.
## Open development
-All work on Vespa happens directly on Github,
-using the [Github flow model](https://guides.github.com/introduction/flow/).
-We release the master branch four times a week and you should expect it to always work.
+All work on Vespa happens directly on GitHub,
+using the [GitHub flow model](https://docs.github.com/en/get-started/quickstart/github-flow).
+We release the master branch four times a week, and you should expect it to always work.
The continuous build of Vespa is at [https://factory.vespa.oath.cloud](https://factory.vespa.oath.cloud).
You can follow the fate of each commit there.
-All pull requests must be approved by a
+All pull requests must be approved by a
[Vespa Committer](https://github.com/orgs/vespa-engine/people).
You can find a suitable reviewer in the OWNERS file upward in the source tree from
where you are making the change (OWNERS have a special responsibility for
ensuring the long-term integrity of a portion of the code).
-The way to become a committer (and OWNER) is to make some quality contributions
+The way to become a committer (and OWNER) is to make some quality contributions
to an area of the code. See [GOVERNANCE](GOVERNANCE.md) for more details.
### Creating a Pull Request
-Please follow
-[best practices](https://github.com/trein/dev-best-practices/wiki/Git-Commit-Best-Practices)
+Please follow
+[best practices](https://github.com/trein/dev-best-practices/wiki/Git-Commit-Best-Practices)
for creating git commits.
-When your code is ready to be submitted,
-[submit a pull request](https://help.github.com/articles/creating-a-pull-request/)
+When your code is ready to be submitted,
+[submit a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
to request a code review.
-We only seek to accept code that you are authorized to contribute to the project.
-We have added a pull request template on our projects so that your contributions are made
+We only seek to accept code that you are authorized to contribute to the project.
+We have added a pull request template on our projects so that your contributions are made
with the following confirmation:
> I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.
@@ -44,15 +44,15 @@ with the following confirmation:
## Versioning
Vespa uses semantic versioning - see
-[vespa versions](http://docs.vespa.ai/en/vespa-versions.html).
+[vespa versions](https://vespa.ai/releases#versions).
Notice in particular that any Java API in a package having a @PublicAPI
annotation in the package-info, and no @Beta annotation on the class,
-cannot be changed in an incompatible way between major versions:
+cannot be changed in an incompatible way between major versions:
Existing types and method signatures must be preserved
(but can be marked deprecated).
We verify ABI compatibility during the regular Java build you'll run with Maven (mvn install).
-This build step will also fail if you *add* to public API's, which is fine if there's a good reason
+This build step will also fail if you _add_ to public APIs, which is fine if there's a good reason
to do it. In that case update the ABI spec as instructed in the error message.
## Issues
@@ -60,13 +60,13 @@ to do it. In that case update the ABI spec as instructed in the error message.
We track issues in [GitHub issues](https://github.com/vespa-engine/vespa/issues).
It is fine to submit issues also for feature requests and ideas, whether or not you intend to work on them.
-There is also a [ToDo list](TODO.md) for larger things nobody are working on yet.
+There is also a [ToDo list](TODO.md) for larger things nobody is working on yet.
## Community
-If you have questions, want to share your experience or help others,
+If you have questions, want to share your experience or help others,
join our [Slack channel](http://slack.vespa.ai).
-See also [Stack Overflow questions tagged Vespa](http://stackoverflow.com/questions/tagged/vespa),
+See also [Stack Overflow questions tagged Vespa](https://stackoverflow.com/questions/tagged/vespa),
and feel free to add your own.
### Getting started