At xcapit, we are open to different types of contributions. Some contribute code changes, others contribute docs, others with translations and others help answer questions from users.
We welcome all contributions from folks who are willing to work in good faith with the community. No contribution is too small and all contributions are valued.
Discussions and General Help
As Xcapit is still at its early stages, drop by on Discord and say hi to know what's next / to get your answers cleared up.
Feedback, Bugs and Issues
Issues in Xcapit's Gitlab repositories are the primary means by which bug reports, feedback and general discussions are made. A contributor is invited to create an issue, discuss, and provide a fix if needed.
Before opening an issue, check to see if there are any current issues with similar key words. This helps us cut down on duplicate tickets.
When you open an issue, you'll notice three templates (bug, custom, feature) with the user-story format we like for our issue reports. When starting a new issue, please do your best to be as detailed and specific as possible.
- Bug report - use this to create a bug report to help us improve Xcapit apps and services
- Feature request - use this to suggest a project idea
- Custom report - use this to report an issue that doesn't fall under any other category
Good First Issues
A good place to start is with some of issues labeled Good First Issue. You can find it in the issues sections of our repositories.
Merge/Pull Request (MR/PR) Process
Before you submit your Merge Request (MR) consider the following guidelines.
- Search for an open or closed MR that relates to your submission. You don't want to duplicate effort.
- Fork the repo that you want to contribute.
- Make your changes in a new git branch. Checkout our branch naming conventions.
git checkout -b bugfix/my-fix-branch
- Create your patch, including appropriate test cases.
- Run the full test suite (see getting started documentation), and esure that all tests pass.
- Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes and tag versions are automatically generated from these messages.
- Push your branch to GitLab
git push origin bugfix/my-fix-branch
- In GitLab, send a merge request to
- If we suggest changes then.
- Make the required updates.
- Re-run the test suites to ensure tests are still passing.
- Rebase your branch and force push to your GitLab repositry (this will update your merge request)
git rebase develop -i
git push -f
That's it! Thank you for your contribution!
After your merge request is merged
After your merge request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository.
- Delete the remote branch on GitLab either through the GitLab web UI or your local shell as follows
git push origin --delete bugfix/my-bugfix-branch
- Checkout the develop branch
git checkout develop -f
- Delete the local branch
git branch -D bugfix/my-bugfix-branch
- Update your local branch with the latest upstream version
git pull --ff upstream develop
Commit Message Conventions
We have very precise rules over our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log.
Commit Message Format
Each commit message consists of a header and a body. The header has a special format that includes a type, a scope and a subject.
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer than 72 characters. This allows the message to be easier to read on GitLab as well as in various git tools.
Samples (even more samples)
fix: Fix translation on defi products list
fix(user-profile-menu): fix redirection to funds when user has funds
Must be one of the following
- chore: Changes that affect the build system or external dependencies and moving files
- ci: Changes to our CI configuration files and scripts
- docs: Documentation only changes
- feat: New feature
- fix: Bug fix
- perf: Code change that improves performance
- refactor: Code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code
- test: Adding missing tests or correcting existing tests
The subject contains succinct description of the change
- use the imperative, present tense: "change" not "changed" nor "changes"
- capitalize the first letter
- no dot (.) at the end
We use and recommend that you use semantic-git-commit-cli to follow our commit message conventions easily.
Branch Naming Conventions (WIP)
We follow a small set of rules to name a collaboration new branch. As in the commit message conventions, this leads to more readable messages that are easy to follow when looking through the project history.
Branch Name Format
Each new branch consists of a type, a issue number and a name.