The Stockpile is an archive that will be used to share academic resources. The design is still evolving and open to new changes and features. At its current stage we are thinking of using Golang with Gin. We will also be using OpenAPI specifications for our API endpoints.
Anyone interested in the project can fork and make a PR to the project. The following are the conventions we will be following for the project.
Your commits should follow conventional commits.
We try to follow clean architecture and write clean code as much as we can. Make sure your contribution confirms to them.
If you have any feature you want to add or if there is an issues you want to work on, you can assign an issue to yourself and then make a PR. Make sure your PR is accompanied with a good description and at least one person is assigned to review it. If you are creating issues, try to check that if it is an existing issue or not. And make the issue as clear as possible. For more reference about good issues and PRs refer to the following resources.
- Writing a proper GitHub issue
- How to Write a Good Issue
- The Anatomy of a perfect pull request
- Writing a great pull request description
Good luck! More will be added as we Go. ;)