Add CONTRIBUTING.md and improve readme #928
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bpierre
approved these changes
Jul 18, 2019
| 1. Celebrate your success after your pull request is merged! | ||
|
|
||
| It's OK if your pull request is not perfect (no pull request is). | ||
| The reviewer will be able to help you fix any problems and improve it! |
|
|
||
| ## Styleguide and development processes | ||
|
|
||
| For the frontends, we use [prettier](https://prettier.io/) and [eslint](https://eslint.org/) to automatically lint and format the project. |
There was a problem hiding this comment.
Maybe we could add that we generally have a npm run lint task to run ESLint with the right configuration, and that we generally provide a .eslintrc and a .prettierrc file (not strictly the case everywhere, but it’s easy to fix)?
README.md
Outdated
|
|
||
| Developing the frontends locally can be a bit tricky, due to the frontends' reliance on a properly configured Aragon client. | ||
|
|
||
| For now, you can follow [@bpierre's gist](https://gist.github.com/bpierre/22572415b90577aa17e5953fa68980eb#developing-the-apps) to start an app's local frontend server and connect it to a locally running Aragon client. |
There was a problem hiding this comment.
Should we start to move this in every frontend-related repository, with a name like CONTRIBUTING_FRONTEND.md or QUICKSTART_FRONTEND.md, even if it’s still incomplete?
There was a problem hiding this comment.
I think we can keep in the CONTRIBUTING and point people to it, perhaps if it's still hard to find we can move it to its own file 😄.
I've also added it in aragon/aragon: aragon/client#880.
ramilexe
pushed a commit
to ConsiderItDone/aragon-apps
that referenced
this pull request
Dec 9, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #370.
Also adds few notes on the branching strategy, as well as some developing and contributing notes.