They are many ways that you can contrubute to PxWeb and the assocoated components e.g. by:
- reporting a bug
- proposing new features
- share information in the wiki
- committing code
Please first discuss the change you wish to make via issue, email before making a change. Keep in mind that Statistics Sweden as an organization and the maintainers of PxWeb are all new to Open Source and we are tring to figure out all the processes our selfs.
This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.
In short, when you submit code changes, your submissions are understood to be under the same Apache License version 2.0 that covers the project.
We use github to host code, to track issues and feature requests, as well as accept pull requests.
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue. But befor doing so please have a look at Github's issues that the bug hasn´t already been reported.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce the bug. Be as specific as possible, it really helps!
- What you expected would happen
- What actually happens
- Attachments e.g. sample file, and logs etc.
We review all new issues once a month, which means that you might not receive any immediate feedback.
We Use Github Flow, So All Code Changes Happen Through Pull Requests Pull requests are the best way to propose changes to the codebase (we use Github Flow).
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- Issue a pull request.
Follow the naming convention from Microsoft also comment your code using XML comments