Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.39 KB

contributing.md

File metadata and controls

66 lines (42 loc) · 2.39 KB
Raw

Contributing

Getting Involved

Welcome to Napptive! This guide will help you know the necessary steps to contribute to our community. Please, first of all, read our code of conduct.

How to contribute

  • Help us to improve documentation.

  • Have you found a bug? We will be very grateful if you inform us oppening an issue. Be clear and concise in the definition of the bug. Indicate the steps to reproduce it, which version you are using, on which platform. Include any additional information that may help to understand the bug.

  • Open an issue. Do you see something that needs work? Do you have any new ideas? Would you like to discuss any functionality? Feel free to open an issue. Fill the issue template being as clear and concise as you can.

  • Have you found a security problem? We would appreciate if you could send us a message to [email protected] informing us of the problem

If you have any questions, you don’t know how to contribute, or you need help, feel free to use Napptive’s Gitter, and we will be happy to help you.

Open a Pull Request

Please:

  • Write understandable and clear git commit messages.
  • Take care of the quality of the code following the official guide.
  • Use gofmt tool.
  • Add comments in the code in order to make it more understandable to the community.
  • Be sure to include the corresponding tests (unit test and integration test if proceed)
  • Fill all the required information in PR template:
### Checklist
- [ ] Code compiles correctly
- [ ] Created tests which fail without the change (if possible)
- [ ] All tests passing
- [ ] Extended the README/documentation, if necessary

#### What does this PR do?

#### Where should the reviewer start?

#### What is missing?

#### How should this be manually tested?

#### Any background context you want to provide?

#### What are the associated tickets?

#### Screenshots (if appropriate)

#### Questions

Be sure to include a clear and detailed PR description that explains the purpose of the PR. Don't forget that the reviewer must know what you are trying to solve, why, and how. Select at least one person to review your PR.

If it is four first contribution, you should sign our CLA document.