Skip to content
This repository has been archived by the owner on Oct 27, 2022. It is now read-only.

Write a contributing guide for project #6

Closed
4 tasks
Bumbleblo opened this issue Mar 22, 2019 · 4 comments
Closed
4 tasks

Write a contributing guide for project #6

Bumbleblo opened this issue Mar 22, 2019 · 4 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Bumbleblo
Copy link
Contributor

Description

Write a initial contributing guide for our project. That document will contain some sections about how contributing, branch creation rules, issues proposals.. etc.

Tasks

Write that sections in a initial version

  • What is the purpose of that project
  • How to find information about that code
  • How to contribute (branch political, issue creation, etc)
  • Style guide

Additional Information

Most part of the open source projects in github don't have a contributing guide, so I do not have a good contributing guidelines to inspire. I'll proposal some organization similar with Atom Guidelines

@Bumbleblo Bumbleblo self-assigned this Mar 23, 2019
@Bumbleblo Bumbleblo added enhancement New feature or request good first issue Good for newcomers labels Mar 23, 2019
@Bumbleblo
Copy link
Contributor Author

How it was decided in #4 the repository language will be English for github and portuguese to documents.

@icaropires
Copy link
Contributor

We (@Bumbleblo, @joaorobson and @ViniciusBernardo ) talked on slack and we think that #n-name-of-issue is a good pattern for branch names and @joaorobson suggested to abbreviate names when possible, I agree with him.

Bumbleblo added a commit that referenced this issue Mar 23, 2019
Signed-off-by: bumbleblo <bumbleblo2013@gmail.com>
Bumbleblo added a commit that referenced this issue Mar 23, 2019
Signed-off-by: bumbleblo <bumbleblo2013@gmail.com>
Bumbleblo added a commit that referenced this issue Mar 23, 2019
Signed-off-by: bumbleblo <bumbleblo2013@gmail.com>
Bumbleblo added a commit that referenced this issue Mar 30, 2019
Signed-off-by: bumbleblo <bumbleblo2013@gmail.com>
@icaropires
Copy link
Contributor

@Bumbleblo, vc se esqueceu de marcar quais tasks foram concluídas.

@icaropires icaropires reopened this Apr 1, 2019
@icaropires
Copy link
Contributor

Relacionada a #34

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants