Found a bug or suggest an improvement, open issues or create pull requests? Please create a new issue or submit a pull request, we will be happy to receive it!
Feel free to take any open issue, just make sure that you follow the contribution guidelines.
BibCNRS is a project by INIST - CNRS a French institute, but for any contribution in this repository we require to use English instead of French. We also highly recommend (if not required) using United Kingdom (UK) variants of English.
Hint: use WordReference to found US/UK variation
<prefix>/<name-of-the-feature>
List of prefix :
prefix | description |
---|---|
feat | Adding new feature |
fix | Fixing a bug |
refactor | Change the structure of some element or change a lot of code |
style | Reformatting of code without altering any functionality |
build | Change in build system |
ci | Change in ci/cd workflow |
prototype | Experimental branch use to test any element who wont or will by added to the project |
Exemple :
- Valide
feat/history
feat/article-page
prototype/new-table-rendering
- Not valide
article-page
- Need a prefixfeat/ajoute-historique
- Need to be in english
When creating or modifying react components, try to use this structure
const MyCompoments = ({data}: MyCompomentsProps) => {
// Hook, Any hook use by this compoments [useHookName()]
// State, only [useState()] hook
// Effect, only [useEffect()] hook
// Memo, only [useMemo()] hook
// Event handler, function use to handle action from jsx html,
// the function need to start with `handle`
return (
<div>
<h1>{data.title}</h1>
<p>{data.text}</p>
</div>
);
}
// Use memo function to memorized the components
export default memo(MyCompoments);
Enable ESLint and Stylelint in your IDE. Those two module is use to ensure code style guideline and in some cases to avoid possible bug.