Skip to content

Commit

Permalink
Update contributing.md file. Refs #756 (#757)
Browse files Browse the repository at this point in the history
* Update contributing
* Update changelog
  • Loading branch information
koenedaele committed Jan 18, 2023
1 parent 285c74b commit 3861aab
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGES.rst
Expand Up @@ -2,6 +2,7 @@ in progress
-----------

- Stop building universal wheels (#752)
- Update CONTRIBUTING.md file (#756)

1.3.0 (04-01-2023)
-------------------
Expand Down
37 changes: 29 additions & 8 deletions CONTRIBUTING.md
@@ -1,11 +1,28 @@
Contributing
============

Atramhasis is being developed as open source software by the
[Flanders Heritage Agency]. All development is done on the agency's
[Github page for Atramhasis].
Atramhasis is an open source SKOS editor developed by [Flanders Heritage].
Consult the [Atramhasis documentation] for more information. All development
is done through our [Github page for Atramhasis]. If you run into bugs or
would like to request a new feature, please open a [Github issue]. Please
provide some context to your question such as the operating system,
Python and Atramhasis versions you are running. If you have specific questions
about the software or the datasets hosted at [Flanders Heritage Thesaurus]
you would rather not address in a public forum, please mail us at
<ict@onroerenderfgoed.be>.

Since we place a lot of importance of code quality, we expect to have a good
If you have some
exerience with Python, Javascript, RDF or SKOS, feel free to contribute
where you can. If you are unsure if a particular change would be welcome,
create a [Github issue] first. When doing so, we recommend you follow these
guidelines.

Please setup a local installation according to the [development guidelines] in
our online documentation, especially if you are looking to make a major
contribution. For certain changes, such as updating a part of the documentation
this is not necessary.

We place a lot of importance on code quality, expect to have a good
amount of code coverage present and run frequent unit tests. All commits and
pull requests will be tested with [Travis-ci]. Code coverage is being
monitored with [Coveralls].
Expand Down Expand Up @@ -33,17 +50,21 @@ bugfix/<ticketnumber>_description_of_fix
feature/<ticketnumber>_description_of_feature
````

Branches should be branched from develop and merged back into develop once approved
through a pull request.
Feature and bugfix branches should be branched from develop and will be merged
back into develop once approved through a pull request.

Every pull request will be run through [Travis-ci]. When providing a pull
request, please run the unit tests first and make sure they all pass. Please
provide new unit tests to maintain 100% coverage. If you send us a pull request
and this build doesn't function, please correct the issue at hand or let us
that doesn't pass all tests, please correct the issue at hand or let us
know why it's not working.

[Flanders Heritage Agency]: https://www.onroerenderfgoed.be
[Flanders Heritage]: https://www.onroerenderfgoed.be
[Atramhasis documentation]: https://atramhasis.readthedocs.io/en/latest
[Flanders Heritage Thesaurus]: https://thesaurus.onroerenderfgoed.be
[Github page for Atramhasis]: https://github.com/OnroerendErfgoed/atramhasis
[Github issue]: https://github.com/OnroerendErfgoed/atramhasis/issues
[development guidelines]: https://atramhasis.readthedocs.io/en/latest/development.html
[Travis-ci]: https://travis-ci.org/OnroerendErfgoed/atramhasis
[Coveralls]: https://coveralls.io/r/OnroerendErfgoed/atramhasis
[pytest]: http://pytest.org
Expand Down

0 comments on commit 3861aab

Please sign in to comment.