Thank you for investing your time in contributing to CSIRT.global! Any contribution you make will be reflected on https://csirt.global :sparkles:.
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
If you spot a problem with the website, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels
as filters. See Labels 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.
Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process.
When you're finished with the changes, create a pull request, also known as a PR.
Congratulations :tada::tada: The CSIRT.global team thanks you :sparkles:.
Once your PR is merged, your contributions will be publicly visible on the https://csirt.global.
This site can be developed on Windows, however a few potential gotchas need to be kept in mind:
\r\n
for line endings, while Unix-based systems use \n
. Therefore, when working on Regular Expressions, use \r?\n
instead of \n
in order to support both environments. The Node.js os.EOL
property can be used to get an OS-specific end-of-line marker.\
for the path separator, which would be returned by path.join
and others. You could use path.posix
, path.posix.join
etc and the slash module, if you need forward slashes - like for constructing URLs - or ensure your code works with either.msys
. While the suggestions below are not guaranteed to work and could cause other issues, a few workarounds include:
git config --system core.longpaths true