Contribuer à SubQuery
Contribuer à SubQuery
Bienvenue et un grand merci d'avoir envisagé de contribuer à ce projet SubQuery ! Ensemble, nous pouvons ouvrir la voie à un avenir plus décentralisé.
Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. :::
What follows is a set of guidelines (not rules) for contributing to SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests.
Code de conduite
We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.
Pour commencer
Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both:
- Recherchez les numéros d'Issues et de PRs existants avant de créer les vôtres.
- Nous nous efforçons de faire en sorte que les problèmes soient traités rapidement mais, en fonction de l'impact, l'enquête sur la cause profonde peut prendre un certain temps. Une mention amicale @ dans le fil de commentaires à l'auteur de la proposition ou à un contributeur peut aider à attirer l'attention si votre problème est bloquant.
Comment contribuer
Rapporter des bugs
Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem:
- Utilisez un titre clair et descriptif de la question pour identifier le problème.
- Décrivez les étapes exactes pour reproduire le problème.
- Décrivez le comportement que vous avez observé après avoir suivi les étapes.
- Expliquez quel comportement vous vous attendiez à voir à la place et pourquoi.
- Incluez des captures d'écran si possible.
Soumettre des Pull Requests
In general, we follow the "fork-and-pull" Git workflow:
- Fork the repository to your own Github account.
- Clone the project to your machine.
- Create a branch locally with a succinct but descriptive name.
- Commit changes to the branch.
- Following any formatting and testing guidelines specific to this repo.
- Push changes to your fork.
- Open a PR in our repository.
Conventions de codage
Messages de commit Git
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
Guide de style JavaScript
- All JavaScript code is linted with Prettier and ESLint.