Commit Graph

7 Commits

Author SHA1 Message Date
Maksym H 3d9f5e8bfc update contributing guide and ui-tests scripts (#1668)
- Updated ./docs/CONTRIBUTION.md to clarify how to use command bot and
update ui-tests locally or in PR
- Moved update-ui-tests.sh to a root of project to run them along for
substrate and polkadot together

---------

Co-authored-by: Mira Ressel <mira@parity.io>
2023-09-22 22:48:38 +01:00
Dónal Murray 41e38b2c09 Fix minor typos and file name in contributing docs (#1651)
# Description

*Please include a summary of the changes and the related issue. Please
also include relevant motivation and context,
including:*

- What does this PR do?

This PR fixes two minor typos in the contributing top level docs, and
fixes a broken link to another file.

- Why are these changes needed?

While reading the guidelines I noticed two small typos and a broken link
to the documentation guidelines in the same directory.

- How were these changes implemented and what do they affect?

Both typos were fixed. The file has been renamed from
`DOCUMENTATION_GUIDELINE.md` to `DOCUMENTATION_GUIDELINES.md` to match
the link, as the link seems correct vs the filename. There are no other
references to this file within this repo.

There are no open issues related to this
2023-09-20 20:11:42 +02:00
Chevdor eaf380aaf5 Add PRdoc check (#1408)
* Add test prdoc
* Prepare for the check
* Escape PR number
* Fix conditional step
* Add checkout and actual check
* Cleanup
* Minor fixes
* Add doumentation
* Add more doc
2023-09-06 11:25:47 +03:00
Chevdor a30092ab42 Markdown linter (#1309)
* Add markdown linting

- add linter default rules
- adapt rules to current code
- fix the code for linting to pass
- add CI check

fix #1243

* Fix markdown for Substrate
* Fix tooling install
* Fix workflow
* Add documentation
* Remove trailing spaces
* Update .github/.markdownlint.yaml

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Fix mangled markdown/lists
* Fix captalization issues on known words
2023-09-04 12:02:32 +03:00
Kevin Krone ea5792508e Add README to project root (#1253)
* Added root README.md draft

* Modified Contribution section to reflect unified guidelines

* Update README.md

Co-authored-by: Squirrel <gilescope@gmail.com>

* Expand Substrate description

* Added Badges and Upstream deps

* Fixed badge links

* Fixed CONTRIBUTING.md links, added security and resources section to root README.md

* Moved runtimes link to Polkadot section

---------

Co-authored-by: Squirrel <gilescope@gmail.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
2023-08-31 20:45:14 +03:00
Sacha Lansky be7f1244c9 Fix links in contributing and PR template docs (#1300)
* add link to labels doc

* add absolute links in PR template

* Update docs/CONTRIBUTING.md
2023-08-30 16:08:47 +03:00
Joyce Siqueira 7c69d14441 update contribution guidelines, remove redundant files (#1181)
* update contribution guidelines, remove redundant files

* removing doc ref labels, updating links on contribution

* add manifest formatting

* update title

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* update links to the new repo

* terminal friendly convention

* update doc guideline format

---------

Co-authored-by: Alexander Samusev <41779041+alvicsam@users.noreply.github.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
2023-08-29 16:47:44 +03:00