| title |
|---|
Developer docs for contributors |
👍🎉 First, thanks for getting involved with Proxeus! 🎉👍
Structure of proxeus-core:
- demo: database dumps with preconfigured content for a fresh or demo server
- deploy: initialization scripts for supported cloud hosting providers
- docs: documentation in Markdown formatting
- doc: auto-generated license documentation
- externalnode: library for plugin nodes
- main: the Go backend and web application main source tree
- service: definition of external API services
- storage: database and file handling
- sys: key utilities, libraries, models, internal services
- test: unit test cases for automated backend & end-to-end testing
Other key repositories include:
- document-service: handling documents, generating PDFs
- node-go: Golang library for nodes (Proxeus extensions)
- proxeus-contract: Solidity code for blockchain support
You can start by checking our core issues board. A few of them are labelled good first issue or hacktoberfest or bounty!
If you would like to work on something, you can:
- Comment on the issue to let us know you'd like to work on, so that we can assist you and to make sure no one has started looking into it yet.
- If good to go, fork the main repository.
- Clone the forked repository to your machine.
- Create a feature branch (e.g.
50-update-readme, where50is the number of the related issue). - Commit your changes to the feature branch.
- Add comments to the issue describing the changes.
- Push the feature branch to your forked repository.
- Create a Pull Request against the original repository.
- add a short description of the changes included in the PR
- Address review comments if requested by our demanding reviewers 😜.
If you have an idea for improvement, and it doesn't have a corresponding issue yet, simply submit a new one.
Join our GitHub Discussions to discuss existing issues and to ask for help.