Skip to content

Latest commit

 

History

History
173 lines (108 loc) · 8.64 KB

CONTRIBUTING.md

File metadata and controls

173 lines (108 loc) · 8.64 KB

Welcome to OperationCaribbeanSummer/WikiAgora contributing guide

I'm really glad you're reading this, because we need volunteer developers to help this project come to WikiAgora.

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on:

Read our Code of Conduct to keep our community approachable and respectable.

If you haven't already, come find us in our github discussions (discussions on GitHub). We want you working on things you're excited about.

Here are some important resources:

Fast intro

These steps will guide you through contributing to this project:

  • Create an issue to discuss about the changes you want to do before starting to code.
  • Fork the repo
  • Clone it and install dependencies 
    git clone https://github.com/OperationCaribbeanSummer/.github
npm install
  • Make changes
  • Create tests
  • Send a Pull Request with a clear list of what you've done. Make sure all of your commits are atomic (one feature per commit).

New contributor guide

To get an overview of the project, read the README file. Here are some resources to help you get started with open source contributions:

Getting started

Navigate our codebase with confidence. codespaces overview

Check to see what types of contributions we accept before making changes. Some of them don't even require writing a single line of code ✨.

Issues

Create a new issue

If you have an idea or enhancement: search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See "Label reference" for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make changes in a codespace

For more information about using a codespace for working on GitHub documentation, see "Working in a codespace."

Make changes locally

  1. Fork the repository.

  1. Install or update to Node.js, at the version specified in .node-version. Install or update MongoDB.

  2. Install dependencies, setup enviromental variables and start with your changes!

Commit your update

Commit the changes once you are happy with them. Don't forget to use the "Self review checklist" to speed up the review process ⚡.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

First contribution

Edit and add your name in CONTRIBUTORS.md, pull it with the comment first contribution and wellcome to the team! 🎊

Your PR is merged!

Congratulations 🎉🎉 The OperationCaribbeanSummer team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible.

Now that you are part of the OperationCaribbeanSummer community.

Submitting changes

Please send a GitHub Pull Request to OperationCaribbeanSummer with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include RSpec examples. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit). Read more at How to Write a Git Commit Message.

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."

Coding conventions

This is open source software. Consider the people who will read your code, and make it look nice for them.

Install slint and prettier, by atent about:

  • .editorconfig
  • .eslintignore
  • .eslintrc
  • .prettierignore
  • .prettierrc

Naming Convention and standards

github branches = main (default)

ISO 8601: Date and time format

ISO 3166-1 alpha-2: Two letter country codes

ISO 639-1: Two letter language codes

snake_cased for JSON Naming Convention based on the Facebook and Twitter APIs

kebab-case for path segments

camelCase for naming const, let,...

OpenAPI specification

Microsoft REST API Guidelines

JSON response

res.json() standad:

{
  "code": 200,
  "status": "success",
  "API_version": "v1",
  "url": "https://OperationCaribbeanSummer.com/api/v1/.....", //API URL
  "data": {
    // response data
  }
}

Thanks, Javier Ramos Nistal