Commit Graph

14 Commits

Author SHA1 Message Date
Marius Vlad af4fb2b9f6 CONTRIBUTING.md: Fix link for patchwork
Noticed this giving a 404 when accessing and it seems that the correct
link is with the 's'.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
2023-04-20 09:46:51 +03:00
Marius Vlad 837ebaf487 CONTRIBUTING.md: Inform users that they'd need to ask for perms
Due to the latest developments fdo no longer allows new users to fork
the Weston project so let's inform users about that.

This also swaps 'Finding something to work on' with 'Sending patches'
paragraph as the first thing users need to look into.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
2023-04-20 09:44:14 +03:00
Pekka Paalanen 9358706743 README: establish no-malloc-failures policy
There are many reasons why trying to handle malloc() returning NULL by
any other way than calling abort() is not beneficial:

- Usually malloc() does not return NULL, thanks to memory overcommit.
  Instead, the program gets SIGSEGV signal when it tries to access the
  memory.

- Trying to handle NULL will create failure paths that are impractical
  to test. There is no way to be sure the compositor still works once
  such path is actually taken.

- Those failure path will clutter the code, increasing maintenance and
  development burden.

- Sometimes there just isn't a good way to handle the failure.

For more discussion, see the issue link below.

Closes: https://gitlab.freedesktop.org/wayland/weston/-/issues/631

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2022-07-20 13:07:22 +03:00
Peter Hutterer eaa5ecf8b2 CONTRIBUTING: update IRC mention to oftc 2021-05-27 08:28:02 +10:00
Pekka Paalanen 9dc1f26818 CONTRIBUTING: make S-o-b mandatory but pseudonym ok
This was prompted by a recent discussion on #dri-devel IRC channel,
where the use of pseudonyms to maintain anonymity was said to be a
normal and accepted practice. See:
https://people.freedesktop.org/~cbrill/dri-log/index.php?channel=dri-devel&highlight_names=&date=2021-02-09
and look for the discussion around pq and Lyude.
Until then, I was hesitant to accept Signed-off-by's with names that
looked very much not a real name.

Clarify our documentation that pseudonyms are ok.

Note, that is not what the Linux kernel documentation says today in
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst
which says that pseudonyms are not ok. According to the discussion, this
should probably be fixed in the kernel too.

Since we are now ok with pseudonyms in Signed-off-by, there is no reason
left to accept any patches without a Signed-off-by. This clarifies our
policy and takes the burden of case-by-case consideration away from
maintainers.

The wording about needing to use a personal email address is my
addition. The intention is to ensure a globally unique handle for a
person while that person remains anonymous, so that the Signed-off-by
cannot be mistaken for someone elses.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2021-02-22 10:52:28 +00:00
Pekka Paalanen abfe9c0f4d CONTRIBUTING: no more emailed patches
We haven't received any emailed patches in years I think, and they would
be inconvenient to process. Make it clear that emailed patches are
unwanted.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2021-02-22 10:52:28 +00:00
Pekka Paalanen 1aa3f52fb5 contributing: add copy of DCO
The DCO was fetched from https://developercertificate.org/ on Feb 4, 2019.
DCO-1.1.txt is a verbatim copy of it.

We should carry a copy of this legal document to be explicit on what wording we
refer to. A link to the URL is not enough, because it may go stale or change
contents without notice.

This clarifies on what the S-o-b actually means. The meaning itself is the same
as before.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2019-07-16 11:43:57 +00:00
Marius Vlad 5baeaecad2 README/CONTRIBUTING: Markdown fixes
Found while being parsed by doxygen (when used recursively), this fixes
the markdown bits as to be displayed properly.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
2019-06-25 14:05:54 +00:00
Emmanuel Gil Peyrot 426c24673f Fix typos all around (thanks codespell!) 2019-02-20 16:47:35 +01:00
Daniel Stone 7d0170cf8a CONTRIBUTING: How do I get started?
Attempt to answer the question on everyone's lips.

Signed-off-by: Daniel Stone <daniels@collabora.com>
2018-08-28 17:55:02 +01:00
Will Thompson 103dc42b5e
doc: fix typos in CONTRIBUTING.md
* Cover letters are no more; presumably the changes since the previous
  revision should be summarised in the MR
* Code should be indented with tabs, not implemented with tabs

Signed-off-by: Will Thompson <will@willthompson.co.uk>
2018-08-07 15:19:01 +01:00
Daniel Stone 8798fa7fdf doc: Use GitLab MRs for patches, not the list
Though Wayland and the protocols still use mail-based patch review,
Weston can now move to GitLab MRs with review through that system.

Add some documentation on how to submit patches through GitLab,
specifically targeted at people who may be familiar with GitLab review,
but not familiar with our rebasing microcommit workflow.

Signed-off-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Quentin Glidic <sardemff7+git@sardemff7.net>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2018-08-07 14:38:38 +01:00
Daniel Stone 3a6fa200b7 doc: Update CONTRIBUTING for Weston
Change some Wayland-specific references to instead refer to Weston.

Signed-off-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Quentin Glidic <sardemff7+git@sardemff7.net>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2018-08-06 11:55:43 +01:00
Pekka Paalanen 2e3915f1bf Add CONTRIBUTING.md document
Taken from Pekka's wayland/wayland@630c25f4c1 and follow-ups, use
Wayland's CONTRIBUTING document as a basis for Weston.

Signed-off-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Quentin Glidic <sardemff7+git@sardemff7.net>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2018-08-06 11:55:40 +01:00