Jay Vercellone
38739fc8bc
docs(contributing): fix links and build tool list
...
* Fix a couple of broken links related to code styling and linting
* Add `jq` and `xz` to the list of build tools (needed when running
`make verify`)
* Add links to the website of all the listed build tools
Signed-off-by: Jay Vercellone <juanjov@gmail.com>
2024-12-27 08:35:09 -08:00
Thomas Gosteli
bea695dc53
docs(contributing): document how to install stress tool
...
Signed-off-by: Thomas Gosteli <thomas.gosteli@protonmail.ch>
2024-10-02 07:37:04 +02:00
James Blair
32726e724a
Update documentation for migration to prow.
...
Signed-off-by: James Blair <mail@jamesblair.net>
2024-05-23 06:36:50 +12:00
Chun-Hung Tseng
39ccdb0b91
documentation: improve CONTRIBUTING.md
...
Signed-off-by: Chun-Hung Tseng <henrybear327@gmail.com>
2024-04-09 18:00:56 +02:00
Chun-Hung Tseng
6e0a4c7f82
documentation: fix typos in documentations and contribution guides
...
Signed-off-by: Chun-Hung Tseng <henrybear327@gmail.com>
2024-04-09 18:00:49 +02:00
Siyuan Zhang
e2d159f08f
Add a flaky test section to contributor guide.
...
Signed-off-by: Siyuan Zhang <sizhang@google.com>
2024-03-01 11:47:25 -08:00
Benjamin Wang
f7d264d1ef
update contributing guide to ensure there is an associated issue for each PR
...
Signed-off-by: Benjamin Wang <benjamin.ahrtr@gmail.com>
2024-01-12 10:36:10 +00:00
Mofi Rahman
569cf2d2b9
doc fix: add instruction for installing protoc and yamllint in contributing.md
...
Signed-off-by: Mofi Rahman <mofi@google.com>
2023-11-10 05:54:33 +00:00
James Blair
aa67cbe6aa
Complete migration to OWNERS file.
...
Signed-off-by: James Blair <mail@jamesblair.net>
2023-11-05 00:02:45 +13:00
Xuan
62907bc842
Update issues links in CONTRIBUTING.md
...
etcd-io/etcd#16424 Find issues links in CONTRIBUTING.md should search for all repositories under etcd-io organization
Signed-off-by: Xuan <nguyenxndaidev@gmail.com>
2023-08-16 22:43:05 +02:00
Marek Siarkowicz
b4c1fb14e3
Move to community membership model closer to kubernetes one
...
Based on https://github.com/kubernetes/community/blob/master/community-membership.md
Changes:
* Extracted contributor membership to separate file
* Provide more detailed requirements for each role. Base maintainers on
kubernetes subproject owners.
* Introduction of member role
Signed-off-by: Marek Siarkowicz <siarkowicz@google.com>
2023-04-03 16:42:01 +02:00
Samruddhi Khandale
cd219ca8df
Update CONTRIBUTING.md reference for Codespaces
...
Signed-off-by: Samruddhi Khandale <samruddhikhandale@github.com>
2023-03-13 17:39:17 +00:00
James Blair
b4c499ed7a
Update contributing docs with new codespaces developement option.
...
Signed-off-by: James Blair <mail@jamesblair.net>
2023-03-09 22:28:25 +13:00
Myrat92
2eadb0ab74
contributing: invalid command for install tools
...
Fix command for install build tools
Signed-off-by: Myrat92 <zjsegzhf@gmail.com>
2023-02-09 16:05:37 +08:00
Bhargav Ravuri
dadd7358f4
Makefile: Read GO_BUILD_FLAGS from env and prepend
...
Build flags read from env GO_BUILD_FLAGS are prepended to
flags in Makefile and sent to scripts/build.sh for building
executables (etcd, etcdctl & etcdutl).
Signed-off-by: Bhargav Ravuri <bhargav.ravuri@infracloud.io>
2022-12-01 09:43:26 +05:30
Marek Siarkowicz
993f3c0942
Fix priority/important label
2022-11-17 20:44:31 +01:00
Marek Siarkowicz
bea478266e
makefile: Raname targets update* to fix* to distinquish from update_dep
...
Signed-off-by: Marek Siarkowicz <siarkowicz@google.com>
2022-09-20 13:58:17 +02:00
Marek Siarkowicz
7bb114d171
makefile: Make static analysis commands easier to use
...
Signed-off-by: Marek Siarkowicz <siarkowicz@google.com>
2022-09-15 11:54:14 +02:00
Marek Siarkowicz
a36bcfff1f
Improve contributor guidelines and simplify development commands
...
Signed-off-by: Marek Siarkowicz <siarkowicz@google.com>
2022-09-14 09:39:32 +02:00
Cenk Alti
66d37aaf1d
Setup golangci-lint GitHub action.
...
Part of "Enhance the static-analysis workflow" issue. #14164
Signed-off-by: Cenk Alti <cenkalti@gmail.com>
2022-08-27 14:06:11 -04:00
Sahdev Zala
e3787ef706
Remove IRC ref
...
The IRC is not used and so removing it as per previous discussion
with the etcd team.
Signed-off-by: Sahdev Zala <spzala@us.ibm.com>
2022-08-24 15:52:05 -04:00
Ramsés Morales
a7a48168a0
Add golangci-lint config file and make
target.
...
Here we add file `.golangci.yaml`, to have a common configuration for
static analysis. If you use the following IDEs/editors, they will read
the file:
- `vim` with vim-go.
- VSCode.
The initial configuration file is based on Kubernetes' HEAD. We removed
a custom kubernetes-linter for custom kubernetes-logging. We also
changed to Golang version 1.17 (etcd's current target Golang version)
from 1.18.
Also, we added a new target to `Makefile`: `lint`. NOTE that auto-fixing
should be part of a later commit, once we are all happy with how the
configuration file is working for us.
As expected, this change fixes two issues found by this `.golangci.yaml`
in file `contrib/lock/client/client.go`:
- Dead code, removed.
- Innefective assignment, removed.
Finally, we are updating `CONTRIBUTING.md` to mention `golangci-lint`.
We will add a GitHub-action to run `golangci-lint` in a future change.
Local testing done:
- `make build`.
- `make test`.
Both are happy.
This is the initial step to fix
https://github.com/etcd-io/etcd/issues/14164 .
Signed-off-by: Ramsés Morales <ramses@gmail.com>
2022-07-28 17:55:08 -07:00
Gyuho Lee
5a0a1a4b45
markdowns: rename "master" branch references to "main"
...
Signed-off-by: Gyuho Lee <leegyuho@amazon.com>
2021-05-12 10:41:02 -07:00
Allen Porter
1906cfdc48
etcdserver: Fix "reporting bugs" link in documentation, which currently 404s
...
Update the "reporting bugs" link to be the current correct url from the documentation, replacing a dash with an
underscore in the URL.
2021-04-01 19:24:15 -07:00
Nate W
d41e18817a
Updating links in .md files after removing Documentation.
...
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
2021-02-25 12:59:57 -08:00
Elad Ben-Israel
819f5cf32f
contributing: invalid link to "reporting-bugs"
...
Fix link to the reporting bugs document
2020-02-09 14:37:25 +02:00
Sahdev P. Zala
4681061b1f
*: add slack contact
...
Add slack chat contact.
2019-09-22 16:12:31 -04:00
Sam Batschelet
69ed707fab
CONTRIBUTING: clarify commit message style
...
Signed-off-by: Sam Batschelet <sbatsche@redhat.com>
2019-01-18 13:00:24 -05:00
mas9612
963d76fc4c
CONTRIBUTING: fix repo name
2018-11-11 23:25:53 +09:00
Gyuho Lee
572d486c5b
*: update github links
...
Signed-off-by: Gyuho Lee <leegyuho@amazon.com>
2018-08-29 14:28:36 -07:00
Anthony Romano
89e4b62a01
Documentation: point contributing irc channel to #etcd
2017-07-14 10:56:09 -07:00
Anthony Romano
c8a2c7f64f
*: eschew you from documentation
...
Removed line wrapping in affected files as well.
2017-03-06 11:40:46 -08:00
Anthony Romano
35229eb2d3
Documentation: conform to header style
2016-06-27 12:00:24 -07:00
Sergey Mudrik
3dad5fffc0
documentation: changed link to style doc
...
Go-project has been moved from code.google.com to github.com
2015-10-28 21:49:28 +02:00
Chance Zibolski
ad843341a9
Contributing: Link to reporting bugs doc
2015-08-25 12:15:03 -07:00
Alex Chan
0c63e16ae0
docs: small fixes to spelling and similar
...
This commit is a collection of fixes to spelling, capitalisation
and spacing. No substantial changes.
2015-05-13 11:45:00 +01:00
Brian Waldon
5b4fe8a558
CONTRIBUTING: update link to style guide
2014-09-18 15:03:55 -07:00
Brandon Philips
138ac0b296
CONTRIBUTING: require two people to review on etcd
2014-09-07 19:46:06 -07:00
Blake Mizerany
8e6c8e068d
.: add MAINTAINERS file
2014-09-04 18:01:09 -07:00
Blake Mizerany
8408acf995
.: explain the LGTM protocol
2014-09-04 17:08:21 -07:00
Brandon Philips
ac7e6bb002
Merge https://github.com/coreos/template-project
...
Conflicts:
CONTRIBUTING.md
LICENSE
2014-06-25 08:57:02 -07:00
Brandon Philips
774cf34827
CONTRIBUTING: add a section about not emailing maintainers
...
Setup some expectation for etiquette.
2014-06-18 18:38:28 -07:00
Brandon Philips
92df44276d
CONTRIBUTING: remove the subject verbs
...
After talking to a few people on the team we have decided that the
feat/fix/etc tags aren't adding much value. Use a simpler format
instead.
2014-06-18 18:36:00 -07:00
Brandon Philips
11525d357f
fix(CONTRIBUTING): point to new mailing list
2014-04-10 15:20:28 -07:00
Jonathan Boulle
fd9ad4fa2c
docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO
2014-04-04 10:58:34 -07:00
Jonathan Boulle
2e4ea503b0
chore(contributing): clean up CONTRIBUTING.md and split out DCO
2014-04-04 10:40:37 -07:00
Brandon Philips
653274b9f6
fix(CONTRIBUTING): minor grammar fixes
2014-03-06 14:12:51 -08:00
Yicheng Qin
e80a35edbe
docs(CONTRIBUTING): add code style section
2014-03-06 13:38:20 -08:00
Brian Waldon
c4605160c5
fix(CONTRIBUTING.md): Fix title case
2014-02-05 15:51:24 -08:00
Brandon Philips
054de85da2
feat(*): initial commit
2014-01-19 12:25:11 -08:00