Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add documentation about the application (en-US) #39

Open
hmartiins opened this issue Jun 21, 2021 · 0 comments
Open

feat(docs): add documentation about the application (en-US) #39

hmartiins opened this issue Jun 21, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation feature request New feature or request

Comments

@hmartiins
Copy link
Member

Documenting the application

The PeruibeTec team is continuing to document its application. Our aim is to have the entire application documented, thus clarifying any doubts about the application's architecture, routes or features. First we will document the application in English, as it is the main language of the repository (as described in CONTRIBUTING.MD) and after that, we will translate this documentation to Portuguese (pt-br), as it is our native language

How to contribute to the creation of the documentation?

You can contribute in different ways to the PeruibeTec server documentation, you can:

  1. Correct spelling mistakes;
  2. Point out possible improvements to the documentation;
  3. Documenting something you deem important to be documented

Before performing any of these steps, create an Issue, or be responsible for an Issue already created (if you have questions on how to create an issue, see CONTRIBUTING.md)

Creating my documentation file

If you're not from PeruibeTec's core, and want to create a file documenting something, follow these steps:

  1. Create an issue with a documentation label
  2. Within this Issue, say what your idea of ​​documentation is
  3. Wait for a moderator to approve your idea (the moderator can disapprove or suggest changes to the idea)
  4. After approval, create a Fork of this repository for your user
  5. Create a branch on your fork called yourusername-en-documentation-yourideia (example: hmartiins-en-documentation-architeture-for-project)
  6. push to your fork, with the created file
  7. Create a new Pull Request in this repository, and the title should be feat(docs): English documentation <your documentation>
  8. Within Pull Request, check @hmartiins, @PocketLocked and @devLeSilverio, so we can review
  9. If everything is OK, congratulations your documentation is now part of PeruibeTec 🎉

If you still have any doubt, comment it here in this Issue, your doubt may be the doubt of other people too..

@hmartiins hmartiins added documentation Improvements or additions to documentation feature request New feature or request labels Jun 21, 2021
@hmartiins hmartiins changed the title feat(docs): add documentation about the application (English) feat(docs): add documentation about the application (en-US) Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature request New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant