Commit Graph

35 Commits

Author SHA1 Message Date
Javi Martín
6f7d4096f5 Add document about our coding conventions
There are some conventions that can't be checked by linters and were not
documented anywhere.
2025-01-13 16:26:42 +01:00
Javi Martín
4e010708e5 Update list of maintainers 2024-12-19 14:46:16 +01:00
Javi Martín
3a173fdb0b Use two spaces to indent lists in markdown
We were already doing it in the `docs/` folder, and this is consistent
with the indentations we use in prettly much every programming language.
2024-06-21 15:57:52 +02:00
dependabot[bot]
74713ffbb2 Bump mdl from 0.11.0 to 0.12.0
Note we need to update the indentation of nested unordered list due to a
change in MDL [1].

Bumps [mdl](https://github.com/mivok/markdownlint) from 0.11.0 to 0.12.0.
- [Changelog](https://github.com/markdownlint/markdownlint/blob/main/CHANGELOG.md)
- [Commits](https://github.com/mivok/markdownlint/compare/v0.11.0...v0.12.0)

---
updated-dependencies:
- dependency-name: mdl
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

[1] https://github.com/markdownlint/markdownlint/commit/67f8312aae

Signed-off-by: dependabot[bot] <support@github.com>
2023-08-29 15:53:08 +02:00
Javi Martín
054aef3854 Change URLs to use the new domain 2023-07-12 16:05:33 +02:00
Javi Martín
629756dd15 Change URLs referencing our GitHub repositories 2023-07-12 16:05:26 +02:00
Senén Rodero Rodríguez
514494fbf5 Add instructions regarding i18n translations 2022-05-03 10:44:55 +02:00
Javi Martín
2ea098cdd9 Update core members 2021-07-02 16:48:28 +02:00
Javi Martín
c6a90b266d Use Pronto to check code conventions
This way developers can run the checks on their machines and using
`bundle exec` we guarantee the right versions of all our gems are being
used; with Hound we can only use the versions supported by their
service.

When including the pronto-erb_lint gem, we're getting errors in
development where our ERB does not follow the conventions Better HTML
expects. Since we only use Better HTML because ERB Lint depends on it,
and right now we are not ready to follow its conventions, we're
disabling it.

Note pronto depends on rugged, which requires CMake and pkg-config to
build the `libgit2` library it depends on. CMake and pkg-config are
installed by default in some GNU/Linux distributions like Ubuntu, but
might not be installed on other systems, so we're adding them as
development dependencies.
2021-03-02 15:48:24 +01:00
Javi Martín
375134ea04 Run the test suite using GitHub Actions
Using GitHub Actions has a few advantages over using Travis CI:

* More jobs can be run in parallel
* All CONSUL repositories on GitHub will be configured automatically

Besides, Travis have recently changed their policy twice. First, they
announced their site for free software projects would be shut down but
free software projects could still use their site for private projects.
And then, they limited the usage of their services for free software
projects.

Just like we used to do with Travis, we're enabling builds for pull
requests but not for pushed branches.

We're also building the master branch. Even if we never push to the
master branch directly, we're aware other CONSUL repositories do, so
we're running the tests for this case.
2020-11-23 14:00:33 +01:00
decabeza
b5b103ac67 Update contributing 2020-04-28 10:27:30 +02:00
Javi Martín
67949b8292 Put information about reporting issues together 2019-11-06 17:25:34 +01:00
Javi Martín
470ee07e77 Add information about coding conventions
We split the section about pull requests, reducing the steps needed to
contribute since there's already a link to help people working on their
first pull request, and the rest don't need to be told to fork the repo.
2019-11-06 17:25:33 +01:00
Javi Martín
b6eebd7852 Fix typos 2019-11-06 17:21:42 +01:00
Javi Martín
72ff3bc5bc Remove obsolete contributing information
Current team members don't use twitter very often, the `Not-ready` label
has has been removed, and issue assignees are sometimes deceiving.

We're also removing the "Limpiar" section from the Spanish document,
which had already been removed from the English document in commit
8eb8bb9a.
2019-11-06 17:21:42 +01:00
Javi Martín
9889ed23e7 Replace PRs welcome references with help wanted
As done in commit 7e3eb28c.
2019-11-06 17:21:42 +01:00
Javi Martín
847506fac9 Move contributors to the bottom of CONTRIBUTING.md
This information isn't really relevant. The most important thing about
this file is describing how to contribute to this project.
2019-11-06 17:21:42 +01:00
voodoorai2000
2fc1a85f0f Update CONTRIBUTING.md 2019-04-16 17:19:44 +02:00
Raimond Garcia
8eb8bb9a59 Remove unused cleanup section
Contributors seem to prefer concrete issues rather that general cleanup guidelines
Removing to make CONTRIBUTING.md more succinct and helpful
2018-07-31 20:10:03 +02:00
Raimond Garcia
deafddae3c Clarify that specs are needed in almost all PRs 2018-07-31 20:08:36 +02:00
Bertocq
7a84d3867a Remove gemnasium references, service just shut down
Gemnasium has closed, service stopped.
2018-05-15 14:52:52 +02:00
BertoCQ
dadeaf4c50 Fix typo in contributors.md 2017-11-06 19:34:24 +01:00
BertoCQ
d05fc42c5a Add Maria Checa to contributors 2017-11-06 19:33:46 +01:00
Bertocq
76ac788823 Improve Readme with PRs-welcome badge, plus PR guide link
Why:

* Try to make the repo more friendly for first time contributors and any contributor on general

How:

* Adding a PRs-welcom badget that links to the issues list filtered by PRs-welcome label
* Adding a Link to on the Contributing guide to a free course about Pull Request and Contributions on Github.
2017-06-29 18:32:26 +02:00
Juanjo Bazán
1912d57dc7 adds Berto to core team 2017-06-26 16:47:58 +02:00
Juanjo Bazán
a2caffef18 defaults to EN docs 2017-06-26 16:47:58 +02:00
Juanjo Bazán
b466d6fe18 removes default lang for contributing file 2015-11-20 20:01:48 +01:00
Juanjo Bazán
500fe127d1 adds mention of the CoC to the contributing file 2015-08-19 11:35:40 +02:00
rgarcia
73e1365320 updates Contributing with best practices 2015-08-12 15:16:03 +02:00
Juanjo Bazán
601b0ac390 typo 2015-08-07 14:17:57 +02:00
Juanjo Bazán
1a97c23b94 we ❤️ our contributors 2015-08-07 14:12:46 +02:00
Enrique García
1ffcd35ed5 Update CONTRIBUTING.md 2015-08-03 18:34:26 +02:00
Juanjo Bazán
d517ca4193 adds references to contributing-related tags 2015-08-03 17:21:17 +02:00
Juanjo Bazán
8141acafc2 typos 2015-07-30 17:51:08 +02:00
kikito
250358bcaf Adds CONTRIBUTING.md 2015-07-30 17:41:25 +02:00