feat(Docs): Development guide #57
Conversation
DEVELOPMENT.md
Outdated
| diesel setup --database-url='postgres://localhost/plume' | ||
| diesel migration run --database-url='postgres://localhost/plume' | ||
| ``` | ||
| #### Configuration |
There was a problem hiding this comment.
I think this part should be moved after "Running Plume"
DEVELOPMENT.md
Outdated
| git remote add upstream https://github.com/myname/Plume.git | ||
| ``` | ||
| Now, make any changes to the code you want. After committing your changes, push to the upstream fork. Once your changes are made, visit the GitHub page for your fork and select "Make Pull Request". Add descriptive text, any issue numbers using hashtags to reference the issue number, screenshots of your changes if relevant, a description of how you tested your changes, and any other information that will help the project maintainers be able to quickly accept your pull requests. | ||
| The project maintainers may suggestion further changes to improve the pull request even more. After implementing this locally, you can push to your upstream fork again and the changes will immediately show up in the pull request after pushing. Once all the suggested changes are made, the pull request may be accepted. Thanks for contributing. |
There was a problem hiding this comment.
I don't know if you wanted to create a new paragraph here, but if you did, you should make sure to add a blank line between the two paragraphs.
Yes, when I wrote the instructions in the README, we had a |
|
Cool!. Removing the content from README.md leaves it feeling a little light. I'm trying to think of more stuff to put there. Je voudrais polir le UI suivante. I would like to work on bringing some polish to the UI next if you think that's a good idea. After that we could add some screenshots. |
|
Yes, the README is a bit short now. But that's not a real problem I think 🤷♂️ If you want to work on the UI, keep in mind that that a redesign have been started in #31, so it may be better to wait for this branch to be merged before (the requested changes should be made soon, normally, so it will probably be merged in a few days). |
Hey - very rough first draft with some more detailed instructions to help with first time contributors. Feel free to jump in and edit yourself if you want to make some changes. Otherwise open to suggestions, corrections, or different ways of doing things. Ideally eventually this would also have Linux and Windows specific instructions. Also eventually it would be nice to break this out into a Development guide as well as a Contributing guide. Once this is in good shape, we can remove some of the duplicate information from the README.md and maybe just add a link.
Besides just having a little more detail, the main difference between this and the existing instructions are that I needed to set the
--database-url='postgres://localhost/plume'fordiesel setupanddiesel migration.