Welcome to the gitote codebase. We are so excited to have you. With your help, we can build out Gitote to be more stable and better serve our platform.
Gitote is an open source end-to-end software development platform with built-in version control, issue tracking, code review, and more.
We expect contributors to abide by our underlying code of conduct. All conversations and discussions on GitHub (issues, merge requests) and across Gitote must be respectful and harassment-free.
When in doubt, ask a core team member! You can mention us in any issues . Any issue with Good first Issue tag is typically a good place to start.
Refactoring code, e.g. improving the code without modifying the behavior is an area that can probably be done based on intuition and may not require much communication to be merged.
Fixing bugs may also not require a lot of communication, but the more the better. Please surround bug fixes with ample tests. Bugs are magnets for other bugs. Write tests near bugs!
Building features is the area which will require the most communication and/or negotiation. Every feature is subjective and open for debate. The product roadmap should be a good guide to follow. As always, when in doubt, ask!
- Fork the project & clone locally. Follow the initial setup here.
- Create a branch, naming it either a feature or bug:
git checkout -b feature/that-new-featureorbug/fixing-that-bug - Code and commit your changes. Bonus points if you write a good commit message:
git commit -m 'Add some feature' - Push to the branch:
git push origin feature/that-new-feature - Create a merge request for your branch 🎉
Nobody's perfect. Something doesn't work? or could be done better? Let us know by creating an issue.
PS: a clear and detailed issue gets lots of love, all you have to do is follow the issue template!
Some existing code may be poorly written or untested, so we must have more scrutiny going forward. We test with go test, let us know if you have any questions about this!
- Try to keep the megre requests small; a megre request should try its very best to address only a single concern.
- Make sure all tests pass and add additional tests for the code you submit.
- Document your reasoning behind the changes. Explain why you wrote the code in the way you did; the code should explain what it does.
- If there's an existing issue related to the megre request, reference to it by adding something like
References/Closes/Fixes/Resolves #305, where 305 is the issue number. More info here - If you follow the megre request template, you can't go wrong.
We run on a Go backend.
Additional technologies and services are listed on our docs.
- Activity timeline
- SSH and HTTP/HTTPS protocols
- Account/Organization/Repository management
- Add/Remove repository collaborators
- Repository/Organization webhooks (including Slack and Discord)
- Repository Git hooks/deploy keys
- Repository issues, pull requests, wiki and protected branches
- Migrate and mirror repository and its wiki
- Web editor for repository files and wiki
- Jupyter Notebook
- Two-factor authentication
- Gravatar and Federated avatar with custom source
- Mail service
This section provides a high-level requirement & quick start guide.
- A Raspberry Pi or $5 Digital Ocean Droplet is more than enough to get you started. Some even use 64MB RAM Docker CaaS.
- 2 CPU cores and 512MB RAM would be the baseline for teamwork.
- Increase CPU cores when your team size gets significantly larger, memory footprint remains low.
curl -O https://storage.googleapis.com/golang/go1.11.linux-amd64.tar.gz
sha256sum go1.11.linux-amd64.tar.gz
tar -xvf go1.11.linux-amd64.tar.gz
sudo chown -R root:root ./go
sudo mv go /usr/local
export GOPATH=$HOME/go
export PATH=$PATH:/usr/local/go/bin:$GOPATH/binPostgreSQL (9.4 or higher)
- Make sure all the prerequisites are installed.
- Fork Gitote repository, ie. https://github.com/gitote/gitote/fork
mkdir -p $GOPATH/src/gitote.com/gitote
cd $GOPATH/src/gitote.com/gitote
git clone https://github.com/gitote/gitote.git
cd gitote
go build
./gitote web -p 8080We're mostly a go app, with a bit of LESS sprinkled in. For most cases, simply running make will do. If you're working with LESS though, you'll need to run the following:
- Run
make lessto compile all LESS files.
Our new product roadmap can be found here. Many notes need to be converted to issues but this should provide an overview of features we plan to work on, as well as features we are considering.
Core team members will move issues along the project board as they progress.
- Backlog: an accumulation of uncompleted work or matters needing to be dealt with.
- Bug: bugs to be fixed.
- Feature Requests: features up for discussion.
- Closed: features we're committed to building -- free for contributors to work on, but please communicate with the owner beforehand.
|
|
This program is free software: you can redistribute it and/or modify it under the terms of the MIT License. Please see the LICENSE file in our repository for the full text.
Happy Coding ❤️