Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

69 lines (49 loc) · 2.65 KB
Raw

Contributing to name.pn

name.pn is an open source product and we work in the open. If you'd like to get involved in the development of name.pn, read on!

License

name.pn is licensed under the AGPL. This is a restrictive license that allows anyone to copy and modify the sources but if their own version is published on the internet, all their modifications must be published in accordance with the same license.

If you don't like the terms of the AGPL, commercial licensing is available. Please contact Fish Percolator if you need a commercial license.

Code of conduct

name.pn is a subscriber to the Contributor Covenant and contributors are expected to abide by the code.

Roadmap

Our roadmap for the next milestone and beyond can be viewed here.

All cards on the roadmap have their own space for conversation, which you are welcome to join in with. Those we particularly want input on are marked "question". Please take a look at these to see if you can help!

If you are a fan of a specific item on the roadmap, drop a 👍 emoji on it using the "smiley face" button so we can prioritise the most important issues.

Raise issues or feature requests

Bugs and feature requests are extremely welcome! Head on over to our issues page to create a new issue for discussion.

Please take a look to see if there is already a thread discussing your bug or feature before adding it!

Contribute code

If you'd like to get involved with making code changes yourself, that would be awesome! Feel free to start a discussion about your idea in the issues section before you begin, or not!

There are guides to getting a development environment set up and how to do things like run the tests over in the README file.

To contribute a change please follow this process:

  1. Fork the repo
  2. Create your change on a branch - we prefer branches named (e.g.) bug/description_of_bug or feature/feature_name
  3. Make sure that new tests are added to defend it. If it's a new feature, those tests should be in Gherkin/Spinach and live in the features/ folder.
  4. Make sure all the existing tests pass.
  5. Raise a pull request to discuss the feature and, if necessary, go through a code review before it is accepted.

Any questions

Any questions, feel free to get in touch with the primary maintainer Quinn, at [email protected].