Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Developer documentation #270

Open
orangejulius opened this issue Mar 10, 2020 · 1 comment
Open

Developer documentation #270

orangejulius opened this issue Mar 10, 2020 · 1 comment
Assignees

Comments

@orangejulius
Copy link
Member

After all these years, we surprisingly don't have much, if any, developer specific documentation! 🤦‍♀️

While related to #263, this would be documentation specifically intended to get people up to speed on contributing to Pelias.

It would include things like:

  • how to submit pull requests
  • how we use Semantic Release and commit messages to manage versions
  • how contributors specifically can (and should) push branches directly to our repos, and how those branches will have docker images created for them
  • which testing libraries we use, how we prefer tests are written or updated, etc
@orangejulius orangejulius self-assigned this Mar 11, 2020
@orangejulius
Copy link
Member Author

I've been working a bit on this and will be opening a PR soon. If anyone has suggestions about things to include in addition to what I've listed above, let me know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant