mirror of
https://github.com/tloncorp/landscape.git
synced 2024-12-30 12:12:50 +03:00
48 lines
2.6 KiB
Markdown
48 lines
2.6 KiB
Markdown
|
# Contributing to Landscape
|
||
|
|
|
||
|
|
Thank you for your interest in contributing to the Urbit ecosystem.
|
||
|
|
|
||
|
|
Landscape is entirely open to contributions from the community. We mainly organize through our [project board], [issues], and [weekly call].
|
||
|
|
|
||
|
|
For now our code is stored in the main [urbit repo]. If you would like to contribute feel free to open up a PR there.
|
||
|
|
|
||
|
|
## Git Conventions
|
||
|
|
|
||
|
|
For Landscape we follow the same conventions as the main repo which can be found in it's [contributing doc]. This can be summarized as the following:
|
||
|
|
|
||
|
|
Commits should try to be atomic and focused on one feature at a time. Work-in-progress commits should be rebased and combined into one so that the commit history stays clean.
|
||
|
|
|
||
|
|
Commits should follow this format:
|
||
|
|
|
||
|
|
> component: short description
|
||
|
|
>
|
||
|
|
> long description
|
||
|
|
|
||
|
|
Where `component` is the closest most relevant area of the code base written as concisely as possible. The short description that accompanies should be a super concise summary of the changes. The total length of the commit message should strive to be 50 characters or less. The long description is optional, but should be used if further explanation is necessary.
|
||
|
|
|
||
|
|
### Pull Requests
|
||
|
|
|
||
|
|
A pull request (PR) should have a title similar in structure to our commit messages where it has a short identifier component followed by a very concise summary of the PR's intent. All PRs should have a description further laying out what it accomplishes. If the PR addresses certain Github issues, those should be referenced in the body of the description so they get linked.
|
||
|
|
|
||
|
|
PRs to this repo should currently tag (or request review) from one of the following contributors:
|
||
|
|
|
||
|
|
- [Liam - @liam-fitzgerald](https://github.com/liam-fitzgerald)
|
||
|
|
- [Hunter - @arthyn](https://github.com/arthyn)
|
||
|
|
- [James - @nerveharp](https://github.com/nerveharp)
|
||
|
|
|
||
|
|
If design or visual changes are made, please provide screenshots and also tag (or request a review) from one of the following contributors:
|
||
|
|
|
||
|
|
- [Éd - @urcades](https://github.com/urcades)
|
||
|
|
- [Gavin - @g-a-v-i-n](https://github.com/g-a-v-i-n)
|
||
|
|
|
||
|
|
## Further Information
|
||
|
|
|
||
|
|
If you haven't yet, check out the main [contributing doc] at the base of the repo for information on how to get started developing on Urbit. Also you can find a host of resources on [developers.urbit.org], including ways to earn address space by contributing.
|
||
|
|
|
||
|
|
[project board]: https://github.com/orgs/urbit/projects/17
|
||
|
|
[issues]: https://github.com/urbit/landscape/issues
|
||
|
|
[weekly call]: https://github.com/urbit/landscape/issues/792
|
||
|
|
[urbit repo]: https://github.com/urbit/urbit
|
||
|
|
[contributing doc]: ../../CONTRIBUTING.md
|
||
|
|
[developers.urbit.org]: https://developers.urbit.org/
|