wemake-services / meta

Home of Repeatable Software Development Process

Hello, we make services!

wemake.services is a group of technology evangelists and simply those who love to write beautiful code. We are dedicated to deliver products of high quality basing on best practices, broad experience and a good portion of common sense. We focus on large, both public-sector and commercial projects with complicated infrastructure, and we care about what we do.

We love Python and Elixir. We use JavaScript.

Repeatable Software Development Process

It is a home and the only source of truth for our Repeatable Software Development Process (also knows as RSDP).

Here we document every possible event and action in our company. You can have a look at how we work.

Structure

• meta website contains every process we have as detailed as possible
• .gitlab folder contains templates for issues and merge requests
• processes/ folder contains our business processes in the BPMN format

Purpose

This is a source code for one of our websites, which states our internal process to our customers and employees.

We try to make them 100% transparent for every member of a project. Wait, what? Isn't it suppose to be super secret?

Well, no. We believe that by making everything transparent everyone wins:

1. Clients know what to expect from us
2. Employees know what their work would be like

But what if someone will just copy this process? We will be actually happy to know that. That's a situation when everyone wins too:

1. Our colleagues will have a nice working business
2. We would exchange our experience in an open manner
3. Clients will receive a software of high quality

Contributing

This is our internal tool, pull requests are not welcomed. But, we welcome any discussion, if you do have any questions or suggestions make sure to share it with us by opening an issue.

License

All contents are licensed under GNU General Public License v3.0. Original license belongs to wemake.services company.

Read the limitations of this license before continuing.

meta's Issues

Section "Configuring new GitLab project" is incorrect

I have missed one very important step: initial commit.
It should be documented.

Fix navigation bar

@valerievich wrote:

1. несоразмерные шрифты “Working with the client”, “Hiring”, “Development process” с ссылкам в этих подразделах. Либо можно вправо сдвинуть ссылки контента, чтоб обозначить вложенность (я вообще не сразу заметил, что это группы ссылок, и решил, что в кучу свалены материалы относящиеся к работе с клиентом, хайрингом и процессом разработки);

We need to fix that.

Separate "Theory" from "Implementation"

Right now we have everything mixed in the docs: some basic theory, our ideas, practical todos, specific tools and settings.

We need to separate that:

1. Basic theory
2. Our implementation
3. Our internal stuff (config, settings, etc)

Sync merge requests and issues

Right now we only use spend micro-command to set spent time on merge requests.

As a result issues do not have any spent time. So, we need to fix that.
There are possible three ways:

1. GitLab may support this some how (good)
2. User can do this by hands (bad)
3. There can be an external script/tool/service to do it (workaround)

Also, this task is related to the #32

Dependabot couldn't find a package.json for this project

Dependabot couldn't find a package.json for this project.

Dependabot requires a package.json to evaluate your project's current JavaScript dependencies. It had expected to find one at the path: /package.json.

If this isn't a JavaScript project, or if it is a library, you may wish to disable updates for it from within Dependabot.

You can mention @dependabot in the comments below to contact the Dependabot team.

Add "Milestones" section

1. What is a milestone?
2. Why do we use it?
3. Is it required to have milestone?
4. Technical aspects: how to create and manage a milestone
5. Is deadline a must or not for a milestone?

Add "Closing invalid tasks" section

Some invalid tasks may appear:

• duplicates
• something that is not needed anymore
• or some other cases

So, this task should be:

• closed
• labels should be removed
• estimate should be removed
• assignee should be removed
• heading should be updated with [Invalid]
• comment why this task is invalid should be created

Only architect can close such issues. Matrix should also be updated.

Time tracking

Time tracking is very important.
We use wakatime to track the spent time.
And we need to create a tutorial on how to set it up, and why we even need this.

Here's how it looks:

What to do with style-guides?

My personal opinion that styleguides should not belong here.
Reasons:

1. They do not have anything to do with the business processes
2. They differ from language to language. Right now we have at least 3 style-guides

So, I think, that they should be removed.

Typo

we don't tend to devote mush time to educate
mush
job-application.md

Think about "Research" issue type

How should we track and bill research tasks?
They happen quite often. And can take a lot of time without writing code.

As for me, each research must end with a document:

• What decision was made?
• Why?
• What were the pros?
• What were the cons?
• What risks are there? How to handle them?

@izomeraza what do you think?

Create style guides

We will need style guides for:

• python
• js
• elixir

Listed in priority. And maybe some other languages as well.
I guess wiki is a good place to store this kind of information.

Examples:

• https://google.github.io/styleguide/pyguide.html
• https://standardjs.com/

Update billing process

Right now we are using a custom semi-automated process to generate invoices and reports for the clients.

There are tools like http://gitlabreports.cosango.com/ which make it very easy.

We need a custom solution to generate reports easily.
Maybe it should be a part of https://github.com/wemake-services/kira workflow.

Remove meta website

Website is not the right format for our meta.
Redirect old urls to the wiki.

Create "Bug bounty" section

We should pay other developers for finding bugs.

There are too kinds of bugs to be found:

1. Just some ordinary bug
2. Security bugs

The price will be counted in minutes of the developers rate.
If developer's rate is not available, then we should use 2000 rubles for calculations.

Security bugs should not be publicly available. To collect them there are two ways:

1. By email
2. Gitlab private issues

Some users report that it is hard to find "TOC"

I guess "TOC" should be opened by default.

Create new structure for clients

Right now it is not clear enough for our future clients what methods we use to manage our porjects.

There are two limitations:

• scope
• time and budget

It is not possible to fulfill both limitations at the same time.
So, we must clarify what is more important in different situations.

Specify how to work with issues

We need to specify how to work with issues:

• time spent and estimated https://about.gitlab.com/features/time-tracking/
• closing issues with commits https://docs.gitlab.com/ee/user/project/issues/automatic_issue_closing.html
• opening new issues if it is not completed yet
• new issue template https://gitlab.com/help/user/project/description_templates.md#setting-a-default-template-for-issues-and-merge-requests

Add "Deploy keys" section

Right now our "GitLab Configuration" docs are missing "Deploy keys" step.

New section "Our clients"

iPhone does not open our website

Adds "Configuring tags" section to Gitlab

Specify, that tag creation is limited.
Tags starting with v* are reserved.

Create "How to create a merge request" section

Add "Dealbreakers" section

There are several dealbreakers for us:

• before we start
• in process

Also they are different for:

• employees
• clients

They should be specified.

Audition refactoring

Right now auditions do not work.

It is impossible to measure the cost before-hands.
Let's consider pay-per-bug payment method.

We need:

• bug cost (it may vary)
• bug definition
• audition environment specification

Separate "Estimations" from "Requirements"

Name our methodology

We also need to list keypoints, inspirations, books.
Maybe some videos too.

Ensure fixes from wednesday are present

Right now I have seen some outdated block, which should be changed.
I don't have the exact list, since I did not make any notices by myself.

Please, @mariamyzz take care of them.

Change screenshots in "Configuring new Gitlab project"

https://wemake.services/meta/rsdp/configuring-new-gitlab-project/

Act of Handover

We need to create the document for closing a project (ltd)

Unclear closing steps

Can you provide please the proper examples of "Completing a Feature" from https://github.com/wemake-services/meta/wiki/Closing-issues. It would be nice to show the steps itself on example of some issue ,to avoid misunderstanding (e.g the way to create a proper new branch name) .

Add "Documentation" issue template

Remove wiki

It is better to have one source of truth. It is a website in our case.

Define what "Done" is

We need to define, what means to "do" something.
When your task is done? So, when should you receive your payment.

Just like in scrum: https://www.scrum.org/resources/scrum-glossary

Add "Punishment" section

We need to create a list of things we punish for.
We also need to specify how we punish in each of these situations.

Update README.md

This readme should have:

1. Our badge
2. Links to the CONTRIBUTING and CHANGELOG files
3. Clear explanation, what this project is about

Restructure the BPMN processes

It should be structured as a directory.
Ideally, it should also have links between different processes in the different files.

Visualize all processes

Use js module to do rate conversion

Right now we don't convert rates. By we need to.
We need to show prices in rubles as we do now, but to convert them to dollars on hover.

Create "Git workflow" page

Our git workflow is very simple yet powerful.
We need to create a special page for it.

Things to cover:

1. master branch
2. issue-* branches
3. merging and reviews
4. releases and tags
5. auto changelogs from closed issues

It would also be nice to create a name for it.

Principles

That's just an list of some principles I don't want to forget about. This issue would be closed after some uncertain period of time.

http://amberonrails.com/move-fast-dont-break-your-api/

Integrate GA

Make sure it is possible to use heatmap and collect user interactions.

Why do we need that:

• we need to know how much time a user spends on our website
• what parts of a website takes the most attention
• how many users visits our website
• from what source

Test assignment

Github repository browsing tool

This task looks like a average task you will receive from us. But it's scope is bigger than usual, since we want to see as much skills as possible.

Subject

We need to create a third-party service to list user's Github repositories.

So, the process is:

1. You log in to Github
2. You log in to our service with Github account
3. It shows a list of all your repositories, your avatar, and username on the same page

Extra

We also want to know the author of this service. Please, provide a link to the source code on the bottom of the page in a form of: Created by <link-to-your-account>, source code: <link-to-the-github-repo>.

Technologies

Fill free to use any tools you like (minding the license). But, note that you are limited to the platform.
If you are applying to python position it would be very strange to submit a js solution.

Result

This should be 100% working and deployed service. You should provide a live link for us to browse it.

Time

Time estimated: from 2 to 3 hours
If it takes more than that, well, I guess you are doing something wrong.

Process

That's how we work internally, maybe it would be helpful: http://wemake.services/meta/employees

Highlight the most important quotes

Each page should contain from 1 to 3 of the most important quotes.
It should be located in the logical places in the text. It may be a duplicate, but it maybe just a single quote.

You should use > for quotes in .md files and <blockquote> in html.

Add test task description

It would be a github browsing tool.

Advantages:

• any platform or programming language
• simple
• has a lot of hidden pitfalls

Update branches name

Now it is just issue-.

Inspirations

There are several meta workbooks I would like to mention:

1. https://about.gitlab.com/handbook/
2. https://github.com/ivelum/job/wiki
3. http://www.reinventingorganizationswiki.com/Main_Page

Starting new project section

I need to specify what steps I should complete each time starting a new gitlab project.
Ideally, we would need a script to handle that. See gitlab-form. Or other tools. Platform is not critical.

Add "First time setup" section

It should include:

• editorconfig setup
• wakatime setup
• docker setup
• python setup

Add "Requirements Analysis" section

We need to specify:

1. How we do it
2. How we approve it
3. That it will and should change
4. How we handle changes
5. What tools do we use to keep everything in sync