Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 4.16 KB

contributing.md

File metadata and controls

39 lines (26 loc) · 4.16 KB
Raw

Contributing

First off, thank you <3 for your interest in Proxeus: an open source project powered by a community of users and supporters like you. We love to receive contributions from our community! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, reporting bugs, requesting features, developing new nodes or writing core code for the Proxeus platform.

Following these guidelines indicates that you respect the time of the maintainers and fellow contributors of the project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you complete your pull requests.

See also About the Proxeus Association for some background.

Community Discussion

We have an open community discussion forum also on GitHub Discussions - this is a great place to share your use cases, any ideas for the platform, get feedback on work that you are doing. Please note the GitHub Community Guidlines and our own ground rules in the Code of Conduct (Contributor Covenant).

Reporting Issues

Please use our GitHub Issue Tracker to open improvement and bug tickets.

If you find a Security Issue - a vulnerability that may affect live or testnet deployments please send your report privately to [email protected] - Please DO NOT file a public issue.

Ground Rules

  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See our Code of Conduct (Contributor Covenant) for details.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
  • Do not commit changes to files that are irrelevant to your feature or bugfix (eg: .gitignore).
  • Take care that code in pull requests meets our coding guidelines. Be willing to accept criticism and work on improving your code; care must be taken not to introduce bugs.
  • Git commits are much more valued when they follow the git commit messages guide.
  • Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
  • If your pull request is merged, please do not ask for an immediate release of a new version. There are many factors contributing to when releases occur. If necessary, please install from the GitLab source until the next official release.

Making your first Contribution

Unsure where to begin contributing to Proxeus? You can start by looking through the open Github Issues. Some are labelled as "good first issue" if they're especially accessible to newcomers.

See the Coding Style section for instructions on the coding style we use. Some more tips are below in the Ground Rules and Getting Started below.

  1. Work on your own fork of the code rather than on a cloned repository. In order to fork a Github project go to ProxeusApp/proxeus-core then click on "Fork" and choose a suitable GitHub account for the fork —eg. your personal Github account. You only need to fork once per repository.
  2. Announce you are on an issue. If you are trying to solve a reported issue, comment that you intend to solve it, and possibly discuss with the community and maintainers the best approach before starting to code.
  3. Create a new branch in your fork (be sure it is synchronized with the original project repository!) and name it after the issue from step #2. Code on that branch and commit your changes (it’s always good to add/fix tests).
  4. Open a pull request after having pushed your changes. Please, be sure to follow this git commit messages guide.
  5. Iterate your changes as the community reviewers or project maintainers comment your code. Your pull request should be accepted as you converge to an accepted solution.