|
|
@@ -1,9 +1,8 @@
|
|
|
# Gitote
|
|
|
|
|
|
-[](https://gitlab.com/gitote/gitote/pipelines)
|
|
|
[](https://goreportcard.com/report/gitote.in/gitote/gitote)
|
|
|
[](https://www.bountysource.com/teams/gitote)
|
|
|
-[](https://gitote.ml)
|
|
|
+[](https://gitote.in)
|
|
|
|
|
|
#### Software version control made simple!
|
|
|
|
|
|
@@ -15,7 +14,7 @@ Welcome to the [gitote](https://gitote.com) codebase. We are so excited to have
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
-We expect contributors to abide by our underlying [code of conduct](CONDUCT.md). All conversations and discussions on Gitote (issues, merge requests) and across Gitote must be respectful and harassment-free.
|
|
|
+We expect contributors to abide by our underlying [code of conduct](CONDUCT.md). All conversations and discussions on Gitote (issues, pull requests) and across Gitote must be respectful and harassment-free.
|
|
|
|
|
|
### Where to contribute
|
|
|
|
|
|
@@ -25,7 +24,7 @@ When in doubt, ask a [core team member](#core-team)! You can mention us in any i
|
|
|
|
|
|
**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](https://gitlab.com/gitote/gitote/boards/716462) should be a good guide to follow. As always, when in doubt, ask!
|
|
|
+**Building features** is the area which will require the most communication and/or negotiation. Every feature is subjective and open for debate. As always, when in doubt, ask!
|
|
|
|
|
|
### How to contribute
|
|
|
|
|
|
@@ -33,7 +32,7 @@ When in doubt, ask a [core team member](#core-team)! You can mention us in any i
|
|
|
2. Create a branch, naming it either a feature or bug: `git checkout -b feature/that-new-feature` or `bug/fixing-that-bug`
|
|
|
3. Code and commit your changes. Bonus points if you write a [good commit message](https://chris.beams.io/posts/git-commit/): `git commit -m 'Add some feature'`
|
|
|
4. Push to the branch: `git push origin feature/that-new-feature`
|
|
|
-5. [Create a merge request](#create-a-merge-request) for your branch 🎉
|
|
|
+5. [Create a pull request](#create-a-pull-request) for your branch 🎉
|
|
|
|
|
|
## Contribution guideline
|
|
|
|
|
|
@@ -47,7 +46,7 @@ PS: a clear and detailed issue gets lots of love, all you have to do is follow t
|
|
|
|
|
|
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!
|
|
|
|
|
|
-#### Create a megre request
|
|
|
+#### Create a pull request
|
|
|
|
|
|
* 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.
|
|
|
@@ -79,17 +78,6 @@ Additional technologies and services are listed on [our stackshare](https://stac
|
|
|
- **Gravatar** and **Federated avatar** with custom source
|
|
|
- **Mail** service
|
|
|
|
|
|
-## Product Roadmap
|
|
|
-
|
|
|
-Our new product roadmap can be found [here](https://gitlab.com/gitote/gitote/boards/716462). 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.
|
|
|
-
|
|
|
## Core team
|
|
|
|
|
|
<table>
|
|
|
@@ -125,6 +113,6 @@ Core team members will move issues along the project board as they progress.
|
|
|
|
|
|
## License
|
|
|
|
|
|
-This program is free software: you can redistribute it and/or modify it under the terms of the **MIT License**. Please see the [LICENSE](https://gitlab.com/gitote/gitote/blob/master/LICENSE) file in our repository for the full text.
|
|
|
+This program is free software: you can redistribute it and/or modify it under the terms of the **MIT License**. Please see the [LICENSE](https://gitote.in/gitote/gitote/blob/master/LICENSE) file in our repository for the full text.
|
|
|
|
|
|
###### Happy Coding ❤️
|
Yoginth